2a0bccb653
Add escaping note to templating docs
...
This moves templating docs to their own section to make it more readable
and easier to reference, and adds information about how to escape
templating in `fleet.yaml`.
2024-04-17 16:08:58 +02:00
13e49003af
Add sections to fleet yaml reference for helm options ( #122 )
...
* Add sections to fleet yaml reference for helm options
The existing inline documentation is getting too long and hard to read.
This adds information on the different types of downloaders.
---------
Co-authored-by: Corentin Néau <tan.neau@suse.com>
2024-04-17 11:45:50 +02:00
24acb0540e
Fixes multi-gitrepo example link
...
Signed-off-by: Xavi Garcia <xavi.garcia@suse.com>
2024-04-05 14:29:10 +02:00
a87cab2727
Updates the docs to say that nested gitrepos is supported
...
Refers to: https://github.com/rancher/fleet/issues/1631
Signed-off-by: Xavi Garcia <xavi.garcia@suse.com>
2024-04-05 14:03:55 +02:00
0cd751bb8c
Merge pull request #118 from rancher/update-cli-docs
...
Update CLI docs
2024-03-22 14:03:23 +01:00
ba45d12c89
Update CLI docs
2024-03-22 14:02:30 +01:00
97f9203d07
Updates fleet repository links after moving to main
...
This PR should be merged after https://github.com/rancher/fleet/pull/2240
It replaces all `fleet` repo references from `master` to `main`
Refers to: https://github.com/rancher/fleet/issues/2234
Signed-off-by: Xavi Garcia <xavi.garcia@suse.com>
2024-03-22 11:21:01 +01:00
3eaf241c9d
Adds a note for pre-releases as semver ignores them by default
...
Signed-off-by: Xavi Garcia <xavi.garcia@suse.com>
2024-02-28 15:46:24 +01:00
db8beec20d
Merge pull request #107 from dnoland1/patch-2
...
Example YAML for webhook service running on a shared host name.
2024-02-01 12:39:46 +01:00
d58f0ba60f
Fixed grammar and spelling error
2024-01-31 09:39:24 -08:00
776bac9884
Add example for chart downloads via git over http.
2024-01-22 10:07:05 +01:00
8691a0fea1
Add info about helmSecretNameForPaths to gitrepo ref
2024-01-19 16:49:38 +01:00
8a911675c3
Add info about go-getter URLs for downloading helm via git
2024-01-19 16:49:11 +01:00
d8f90a5b95
Update generated CRD reference
2024-01-19 16:48:56 +01:00
69838d6a7c
Add azure webhooks doc
2024-01-15 16:12:34 +01:00
93c2f51262
Merge pull request #108 from Woovie/ambiguity-clarification
...
GitRepo Resource Creation Documentation Clarification
2023-12-21 14:34:40 +01:00
fb79092e55
Fix a small newline error
2023-12-20 15:41:42 -08:00
d74fbab6e2
Add known hosts header, move warning
...
This change adds a tertiary header for the `Known hosts` section and
moves the warning to the top to emphasize the importance of adding known
hosts.
2023-12-20 11:50:31 -08:00
2713ff7e48
Clarify ambiguity in GitRepo resource creation
...
The issue here stems from a combination of using the word 'it' to mean
something specific and a lack of grammar. I've corrected both issues to
help clarify intent with the language.
2023-12-20 11:40:50 -08:00
55010ee8ea
Example YAML for webhook service running on a shared host name.
2023-12-18 14:41:52 -08:00
eaf11a6344
add correctDrift to targetCustomization
2023-12-11 11:35:19 +01:00
86f3eddaa7
Fix typo in namespaces docs
...
Namespaces are in use, or used.
2023-11-16 15:26:42 +01:00
7ce9d026f6
Fix typo
...
`will be ran` → `will be run`.
2023-10-30 12:58:30 +01:00
c9fa14e89a
Update generated CLI/CRD reference
2023-10-06 11:38:37 +02:00
c25c001469
Add example for helm to bundle
2023-09-27 10:21:42 +02:00
7a03cd06f2
Add registration secrets diagram
2023-09-22 14:49:16 +02:00
2d41f1e788
Document new Helm options in fleet.yaml ( #93 )
2023-09-20 11:45:14 +02:00
e8bd718952
Improve takeOwnership description
...
that it is supported outside of helm-based bundles.
2023-09-12 10:11:58 +02:00
413a1464fe
Update CRD reference
2023-09-08 15:09:05 +02:00
2c2254b745
Add sections to fleet.yaml helm options
2023-09-05 11:52:46 +02:00
da24ee64d5
Merge pull request #85 from rancher/list-of-deployed-resources
...
Add list of deployed resources
2023-09-04 17:02:16 +02:00
ca53e26c19
Merge pull request #89 from rancher/webhook-docs-performance-recommendations
...
webhook.md: add scalability/performance considerations
2023-09-04 17:01:31 +02:00
5ad3980760
Merge pull request #91 from rancher/update-api-docs
...
Update API docs
2023-09-04 15:28:30 +02:00
badba047da
Update API docs
2023-09-04 15:27:31 +02:00
87a055352d
Fix indenting of warning blocks
...
This ensures that warning blocks about overriding the Helm version of a
chart via target customizations are properly indented and formatted,
even when embedded in lists.
2023-08-30 15:00:57 +02:00
6b39759617
Document bundle size issue with target-customised chart version
...
This adds a warning for Fleet versions from 0.6 onwards about bundle
sizes which may exceed etcd's maximum blob size for bundles containing
multiple versions of a chart as a result of target customisations.
Fleet versions prior to 0.6 did not properly support multiple chart
versions per bundle, hence that warning is not relevant for them.
2023-08-30 15:00:57 +02:00
97ac26802f
webhook.md: add scalability/performance considerations
...
Discussion about an affected use case is available on the internal case SURE-6779.
2023-08-24 11:21:47 +02:00
397e42f082
Describe how cluster registration works in detail
2023-07-28 12:02:54 +02:00
939fe3ff27
Add list of deployed resources
2023-07-28 11:50:11 +02:00
25b9670f95
Update docs/gitrepo-content.md
...
Co-authored-by: Corentin Néau <tan.neau@suse.com>
2023-07-19 14:21:55 +02:00
40d9399eed
Add info about cluster name matcher
2023-07-18 17:37:51 +02:00
b8b90da81c
Fix case mistake in helmRepoURLRegex property
2023-07-14 15:08:27 +02:00
b1faa46011
Document `.fleetignore` support
...
This documents how newly supported `.fleetignore` files behave and which
features they support.
2023-07-11 10:41:50 +02:00
64175ac062
Remove instructions to move local clusters
2023-07-10 17:13:59 +02:00
c72c8e4461
Add namespaceLabels and namespaceAnnotations documentation
2023-07-04 12:33:56 +02:00
357659aaca
Update bundle-diffs.md for broken URL
...
This change fixes a URL that now 404s after repo structure changes. This fixes the 404 caused by https://github.com/rancher/fleet-examples/pull/39
2023-06-30 13:35:06 +02:00
e6d889f8b3
Added a note for bundle names character limitation
2023-06-26 14:06:57 +02:00
6428c3cf37
Add caution banner regarding Fleet in Rancher
2023-06-22 17:11:33 +02:00
5daec02150
Fix line breaks in quickstart.md
2023-06-22 17:01:29 +02:00
2a56f6022a
Incorporate suggestions regarding Fleet helm repo
2023-06-22 17:01:20 +02:00
Corentin Néau