Commit Graph

203 Commits

Author SHA1 Message Date
Mario Manno 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
Xavi Garcia 24acb0540e
Fixes multi-gitrepo example link
Signed-off-by: Xavi Garcia <xavi.garcia@suse.com>
2024-04-05 14:29:10 +02:00
Xavi Garcia 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
Mario Manno 0cd751bb8c
Merge pull request #118 from rancher/update-cli-docs
Update CLI docs
2024-03-22 14:03:23 +01:00
Mario Manno ba45d12c89 Update CLI docs 2024-03-22 14:02:30 +01:00
Xavi Garcia 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
Xavi Garcia 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
Mario Manno 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
David Noland d58f0ba60f
Fixed grammar and spelling error 2024-01-31 09:39:24 -08:00
Mario Manno 776bac9884 Add example for chart downloads via git over http. 2024-01-22 10:07:05 +01:00
Mario Manno 8691a0fea1 Add info about helmSecretNameForPaths to gitrepo ref 2024-01-19 16:49:38 +01:00
Mario Manno 8a911675c3 Add info about go-getter URLs for downloading helm via git 2024-01-19 16:49:11 +01:00
Mario Manno d8f90a5b95 Update generated CRD reference 2024-01-19 16:48:56 +01:00
raul 69838d6a7c
Add azure webhooks doc 2024-01-15 16:12:34 +01:00
Mario Manno 93c2f51262
Merge pull request #108 from Woovie/ambiguity-clarification
GitRepo Resource Creation Documentation Clarification
2023-12-21 14:34:40 +01:00
Jordan Banasik fb79092e55 Fix a small newline error 2023-12-20 15:41:42 -08:00
Jordan Banasik 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
Jordan Banasik 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
David Noland 55010ee8ea
Example YAML for webhook service running on a shared host name. 2023-12-18 14:41:52 -08:00
raul eaf11a6344
add correctDrift to targetCustomization 2023-12-11 11:35:19 +01:00
Corentin Néau 86f3eddaa7 Fix typo in namespaces docs
Namespaces are in use, or used.
2023-11-16 15:26:42 +01:00
Corentin Néau 7ce9d026f6 Fix typo
`will be ran` → `will be run`.
2023-10-30 12:58:30 +01:00
Mario Manno c9fa14e89a Update generated CLI/CRD reference 2023-10-06 11:38:37 +02:00
Mario Manno c25c001469 Add example for helm to bundle 2023-09-27 10:21:42 +02:00
Mario Manno 7a03cd06f2 Add registration secrets diagram 2023-09-22 14:49:16 +02:00
Alejandro Ruiz 2d41f1e788
Document new Helm options in fleet.yaml (#93) 2023-09-20 11:45:14 +02:00
Tim Hardeck e8bd718952
Improve takeOwnership description
that it is supported outside of helm-based bundles.
2023-09-12 10:11:58 +02:00
Mario Manno 413a1464fe Update CRD reference 2023-09-08 15:09:05 +02:00
Mario Manno 2c2254b745 Add sections to fleet.yaml helm options 2023-09-05 11:52:46 +02:00
Mario Manno da24ee64d5
Merge pull request #85 from rancher/list-of-deployed-resources
Add list of deployed resources
2023-09-04 17:02:16 +02:00
Mario Manno 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
Mario Manno 5ad3980760
Merge pull request #91 from rancher/update-api-docs
Update API docs
2023-09-04 15:28:30 +02:00
Mario Manno badba047da Update API docs 2023-09-04 15:27:31 +02:00
Corentin Néau 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
Corentin Néau 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
Silvio Moioli 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
Mario Manno 397e42f082 Describe how cluster registration works in detail 2023-07-28 12:02:54 +02:00
Mario Manno 939fe3ff27 Add list of deployed resources 2023-07-28 11:50:11 +02:00
Mario Manno 25b9670f95
Update docs/gitrepo-content.md
Co-authored-by: Corentin Néau <tan.neau@suse.com>
2023-07-19 14:21:55 +02:00
Mario Manno 40d9399eed Add info about cluster name matcher 2023-07-18 17:37:51 +02:00
David Warburton b8b90da81c Fix case mistake in helmRepoURLRegex property 2023-07-14 15:08:27 +02:00
Corentin Néau 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
raul 64175ac062 Remove instructions to move local clusters 2023-07-10 17:13:59 +02:00
raul c72c8e4461
Add namespaceLabels and namespaceAnnotations documentation 2023-07-04 12:33:56 +02:00
Dan 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
Eduardo Mínguez e6d889f8b3
Added a note for bundle names character limitation 2023-06-26 14:06:57 +02:00
Tim Hardeck 6428c3cf37
Add caution banner regarding Fleet in Rancher 2023-06-22 17:11:33 +02:00
Tim Hardeck 5daec02150
Fix line breaks in quickstart.md 2023-06-22 17:01:29 +02:00
Tim Hardeck 2a56f6022a
Incorporate suggestions regarding Fleet helm repo 2023-06-22 17:01:20 +02:00
Tim Hardeck 5eb3bc38e7
Use Artifact Hub for installing Fleet 2023-06-22 16:36:15 +02:00
raul 8c970d9a6d
Explain drift correction force 2023-06-21 10:04:05 +02:00
raul cb07a60258
Add drift correction docs 2023-06-20 11:57:55 +02:00
Tim Hardeck fd90fa7b60
Update docs/quickstart.md
Co-authored-by: Corentin Néau <tan.neau@suse.com>
2023-06-19 13:45:51 +02:00
Tim Hardeck 4dcf3bfefb
Improve wording of initiated registration 2023-06-19 13:28:20 +02:00
Tim Hardeck 92675a9c46
Improve Deployment management description 2023-06-19 13:20:23 +02:00
Tim Hardeck 60b990957f
Improve Helm 3 requirement description 2023-06-19 13:18:46 +02:00
Mario Manno bccdd241b0 Move info about gitrepo namespaces into gitrepo-add.md 2023-06-13 15:15:16 +02:00
Mario Manno 3fc252a8e0 Add note about default cluster group target 2023-06-13 15:06:34 +02:00
Mario Manno 7b62630261 Use permalink for fleet.yaml struct 2023-06-13 14:54:03 +02:00
Mario Manno e0f204cc3c Remove whitespace at end of the line 2023-06-13 14:50:34 +02:00
Mario Manno f046f7e94a Move helm values explanation into gitrepo-content.md 2023-06-13 14:49:30 +02:00
Mario Manno d6a383ec45
Merge pull request #72 from rancher/clarify-bundle-fields
Notes about bundle fields limitations
2023-06-07 14:57:27 +02:00
Mario Manno 184950d291 Notes about bundle fields limitations 2023-06-07 11:25:49 +02:00
raul 683df8c0dd
Add overrideTargets and doNotDeploy documentation 2023-06-06 11:06:54 +02:00
Raul Cabello Martin 5edb6ce5c9
Document how to use different helm credentials for each path (#69)
* Document how to use different helm credentials for each path

* Clarify which path is used for the helm credentials

Co-authored-by: Mario Manno <mario.manno@gmail.com>

* Add how to use different helm credentials for each path in warning box

* Fix missing line in secrets path explanation

* Clarify path for Bundles

Co-authored-by: Corentin Néau <tan.neau@suse.com>

---------

Co-authored-by: Mario Manno <mario.manno@gmail.com>
Co-authored-by: Corentin Néau <tan.neau@suse.com>
2023-06-02 15:23:27 +02:00
Mario Manno 37a5dbcc3f Fix cluster namespace annotations reference 2023-06-01 18:31:33 +02:00
Mario Manno f3aa78d745 Remove instructions to move clusters
Cluster migration is more difficult
2023-05-30 13:23:07 +02:00
Mario Manno 413abe810c Clarify cluster targeting and customization 2023-05-25 15:29:45 +02:00
Mario Manno 89474ed8ea Remove instructions for moving local cluster to another namespace
This is currently not working and Rancher related instructions belong
into the Rancher docs.
2023-05-25 15:29:45 +02:00
Mario Manno 18f320ecb9 Add troubleshooting instructions to get resource status 2023-05-25 15:29:45 +02:00
raul 5d4b34dbbf
Add fleet agent config docs 2023-05-16 12:44:58 +02:00
Mario Manno b9cdbd2aa1 Fix anchor links for array elements in reference 2023-05-15 16:54:01 +02:00
Mario Manno f5784e23c9
Merge pull request #65 from raulcabello/bundle-cleanup
Add documentation for Bundles
2023-05-15 16:48:26 +02:00
Mario Manno 91775de8e7
Merge pull request #62 from raulcabello/ignore-options
Add documention for ignore conditions
2023-05-15 16:46:52 +02:00
raul 1fd7aba705
Add documention for Bundles 2023-05-15 13:39:36 +02:00
raul 91aeb9cd9f
Add documention for ignore conditions 2023-04-20 15:36:29 +02:00
Mario Manno a4c6e42ef1
Merge pull request #58 from rancher/release-0.6.0
Release of 0.6.0, add agent config rc as next
2023-04-12 12:03:21 +02:00
Mario Manno 3541595717 Release of 0.6.0, add agent config rc as next 2023-04-12 12:02:26 +02:00
Mario Manno 99b715880c Varying function output in helm values will redeploy 2023-04-11 16:34:13 +02:00
raul 73f73ebc71
Document that uuidv4 function is not supported 2023-04-05 11:12:56 +02:00
Mario Manno 0481221a8b
Merge pull request #55 from Nidstaang/patch-1
typos
2023-03-29 10:43:34 +02:00
Mario Manno 6e6204175a Update API docs 2023-03-23 16:11:10 +01:00
Anna J e37e637823
typos
found some typos that made the text a bit difficult to read
2023-03-22 10:17:17 +01:00
Mario Manno 866c94bb30 Titles for warning boxes 2023-03-21 15:31:34 +01:00
Mario Manno 0adb838319 Use architecture image from rancher manager 2023-03-21 15:21:58 +01:00
Mario Manno 037b900846 Clarify "rbac" feature 2023-03-21 15:16:41 +01:00
Mario Manno d7da80b048 Registration reference, summary did not mention ClusterRegistrationToken 2023-03-15 14:44:59 +01:00
Mario Manno cbad61d529 Update docs on valuesFrom 2023-03-15 12:13:48 +01:00
Mario Manno 64b054e0c1 Move helm values info into explanation doc 2023-03-13 16:18:33 +01:00
Mario Manno 4422366220 Update fields for agent settings in cluster docs 2023-03-06 14:41:49 +01:00
Mario Manno 5d8b2c771e Update CRD reference 2023-03-06 13:46:00 +01:00
Mario Manno 2c978e6e5f Fix dependsOn.selector docs
Refers to https://github.com/rancher/fleet-docs/issues/51
2023-03-02 15:53:00 +01:00
Mario Manno da176709eb Split gitrepo/fleet.yaml docs 2023-03-02 15:52:50 +01:00
Mario Manno f53c0f1dbb Single page for cluster registration 2023-03-02 15:50:40 +01:00
Mario Manno 45cc06361e
Merge pull request #50 from rancher/fix_pollingInterval
Fix pollingInterval description
2023-03-02 15:21:51 +01:00
Mario Manno 8a3933a97b Restructure docs
merge

capitalize headers

installation

registration

deployment tutorial
2023-02-28 19:11:07 +01:00
Silvio Moioli 8d146db100
Fix pollingInterval description
Signed-off-by: Silvio Moioli <silvio@moioli.net>
2023-02-27 11:08:58 +01:00
Mario Manno 0bdbbf87dc Quote variables, remove unecessary curlies 2023-02-23 15:07:06 +01:00
Mario Manno 4579c4e3dc Rename variable to API_SERVER_CA_DATA to distinguish it from a pem file 2023-02-23 15:01:07 +01:00
Mario Manno d73fe06409 Add note about backup secrets with rancher-backup 2023-02-23 14:56:14 +01:00