Commit Graph

385 Commits

Author SHA1 Message Date
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
Mario Manno 0d64d7f48c Fix GitRepoRestriction example 2023-02-23 14:49:18 +01:00
Mario Manno 635b1b0fbc Troubleshoot lost agents 2023-02-23 14:47:13 +01:00
Mario Manno 83fd70a6cb Update warning about helm repo credentials 2023-02-23 14:46:41 +01:00
Mario Manno 4963df8fc3 Add --disable-bootstrap to CLI reference 2023-02-23 14:46:20 +01:00
Tim Hardeck 352781379f
Merge pull request #43 from puffitos/patch-1
clusterGroupSelector: corrected usage
2023-02-21 10:44:01 +01:00
Tim Hardeck dd0b640dec
Merge pull request #41 from raulcabello/helm-url-regex
Add helmRepoUrlRegex to the GitRepo docs
2023-02-21 10:40:24 +01:00
raul daa86f93a1 Add waitForJobs parameter to docs 2023-02-16 15:25:25 +01:00
Mario Manno bed14ab709
Merge pull request #40 from bashofmann/dependsOn-bundleSelector
Update dependsOn docs
2023-02-08 15:40:20 +01:00
Bruno Bressi 5aa023647d
clusterGroupSelector: corrected usage
The clusterGroupSelector is a typical label selector which can accept `matchLabels` and `matchExpressions` objects. The documentation has been fixed to showcase the correct usage.
2023-01-31 20:11:24 +01:00
Mario Manno 76ba483e36 Add skipOwnership to fleet.yaml 2023-01-10 18:05:07 +01:00
raulcabello 3dff020955
Add helmRepoUrlRegex to the GitRepo docs 2023-01-10 12:48:27 +01:00
Bastian Hofmann aac339610e
Update dependsOn docs
This adds the missing bundleSelector field and shows how you can configure labels in a bundle.

The feature was added in https://github.com/rancher/fleet/pull/552. There was a docs PR https://github.com/rancher/fleet/pull/574, but this was never merged.
2023-01-04 17:19:39 +01:00
Mario Manno 5d163ed81d Update versioned docs 2022-12-21 16:08:44 +01:00
Mario Manno 8a3a4f104d Add warning about private helm repo credentials
Refers to https://github.com/rancher/fleet/issues/978
2022-12-21 12:26:40 +01:00
Mario Manno 6065c7f35b Add note about releaseName
Copied text from existing PR in rancher/fleet

closes https://github.com/rancher/fleet/pull/720
2022-12-21 11:48:32 +01:00
Mario Manno 917bd22b3e Correction on fleet.yaml structure 2022-12-21 11:44:23 +01:00
Mario Manno b7e4a1b34d Flatten sidebar, move state into references 2022-12-21 11:43:23 +01:00
Mario Manno f4d5b02dd3 Add image to multi-tenancy 2022-12-08 16:26:19 +01:00
Mario Manno 11306ce809 Update template docs for ${ } delims 2022-12-08 12:22:02 +01:00
Mario Manno 5f918b7600 Add note on templating helm values in fleet.yaml 2022-12-08 12:20:54 +01:00
Mario Manno ff4966d00b
Merge pull request #29 from rajiteh/patch-1
docs: fix incorrect template string
2022-12-07 16:22:01 +01:00
Mario Manno 9a2f508c91 Add documentation for valuesFrom secrets and config maps
Refers to https://github.com/rancher/fleet/pull/725
2022-12-07 16:20:57 +01:00
Raj Perera b8ec8522e5
docs: fix incorrect template string 2022-12-02 09:33:09 -05:00
Raj Perera bb3f651ab9 docs: add docs for template values 2022-12-01 13:08:50 -05:00
Mario Manno e0b424d820 Add fleet.yaml and GitRepo into reference
This should make it easier to access the existing texts.
2022-11-29 17:04:16 +01:00
Mario Manno 35b7a208f4 Add note about clusterName target
Fixes https://github.com/rancher/fleet/issues/728
2022-11-29 15:01:47 +01:00
Mario Manno c12323c2dc Add reference for (internal) config options 2022-11-29 13:57:37 +01:00
Mario Manno b391fd4318 Remove empty docs 2022-11-28 17:33:58 +01:00
Mario Manno 0073629091 Store versioned URLs in fleetVersions.js 2022-11-28 17:21:29 +01:00
Mario Manno f95b7ce725 Fix URL format for downloads 2022-11-28 12:02:44 +01:00
Mario Manno 997cba5542
Merge pull request #19 from victorcasado/patch-1
Update multi-tenancy.md
2022-11-28 11:56:54 +01:00
Mario Manno 8ef1625c4f Add generated CRD docs 2022-11-28 11:41:57 +01:00
Mario Manno 76d0d2ee6d Add CLI args reference 2022-11-28 11:41:57 +01:00
Mario Manno 31dab402fd Add some charts about fleet internals 2022-11-28 11:41:57 +01:00
Mario Manno 40156b132d Intro sentence for each git-structure
The first sentence is extracted, by slack for example, to show a summary
of the page when linking it.
So it should be represenatative of the content.
2022-11-28 11:41:57 +01:00
Mario Manno 2ee9332377 Use alpha version in "next" docs 2022-11-28 11:41:57 +01:00
Tim Hardeck 7776827c41
Document behavior of non-existing clusterLabels
if they are used as value reference.
2022-11-22 10:48:15 +01:00
Mario Manno a5dc315f9d Add names to special namespaces
These are the names used in the code.
2022-11-21 14:56:44 +01:00
vcasado e6db8b652f
Update multi-tenancy.md
Fixing a couple of typos
2022-11-18 23:53:41 +01:00
Mario Manno 6a6e8b5b87
Merge pull request #11 from rancher/multi-tenancy
AllowedTargetNamespaces GitRepoRestriction
2022-10-19 10:42:11 +02:00
Mario Manno c7f1aeceb5 Add versioned docs for 0.4, 0.5
* fix image urls
* create json for versioned_sidebars
2022-10-18 17:05:07 +02:00
Mario Manno d9ca4a7359 Remove old {{variables}} from docusaurus markdown
Replacing the version with the latest rc version for now.
We'll move to versioned docs later.
2022-10-18 15:11:24 +02:00
Mario Manno 301112bd5b
Merge pull request #10 from rancher/add-basic-auth-docs
Add http basic auth instructions for repos
2022-10-18 14:57:39 +02:00
Mario Manno b705cae2c5 Add docs for Multi-Tenancy 2022-10-17 18:07:33 +02:00
Mario Manno 832237a2b5 Setting defaults with GitRepoRestrictions 2022-10-17 17:20:50 +02:00
Mario Manno 3246e9d797 Add gitreporestriction section in operator guide 2022-10-17 17:17:18 +02:00
Mario Manno f2a9736dae Add http basic auth instructions for repos
This is not the documentation for helm charts, they use
`helmSecretName`, instead.
2022-10-17 16:05:29 +02:00
Mario Manno f88eb9d722 Turn !!! formatting into admonitions
https://docusaurus.io/docs/next/markdown-features/admonitions
2022-10-14 17:33:49 +02:00
Mario Manno e375edb90e Readable titles for gitrepo-add, bundle-diff pages 2022-10-14 16:50:38 +02:00
Mario Manno 37cd2f8ce8 SSH keys need to be in PEM format
refers to https://github.com/rancher/fleet/issues/542
2022-10-14 16:47:04 +02:00
Mario Manno 922b0fb2ec Document pollingInterval,forceSyncGeneration and paused 2022-10-12 13:39:28 +02:00
Matt Farina fc7bd30cf1 Updating docs to be consistent with other docs from Rancher
Signed-off-by: Matt Farina <matt.farina@suse.com>
2022-10-03 11:40:29 -04:00
divya-mohan0209 9de94a264c Initial commit 2022-09-22 09:54:31 +05:30