Commit Graph

342 Commits

Author SHA1 Message Date
hridyesh bisht 6f370bda89
Fixing images 2025-06-25 18:02:41 +05:30
hridyesh bisht 7e10b1ac6b
Fixing {name} using code snippets 2025-06-24 22:23:36 +05:30
Mario Manno 2f4bb3ab0b Update registration flow chart 2025-06-24 15:19:30 +02:00
Mario Manno 5497d60846 Upgrade to docusauraus 3 and add mermaid support 2025-06-24 15:07:42 +02:00
Patrick Seidensal 657ced37d1
Make sure points in #3586 are documented 2025-06-24 14:49:26 +02:00
Patrick Seidensal 70890a794f
Tiny update 2025-06-24 14:49:26 +02:00
Patrick Seidensal 29b65444f1
Small fixes 2025-06-24 14:49:26 +02:00
hridyesh bisht da7d0f5d1f
Fixing minor typos 2025-06-24 14:49:26 +02:00
hridyesh bisht dcec8f71d0
Second set of changes 2025-06-24 14:49:26 +02:00
hridyesh bisht 251df276a9
First set of changes. 2025-06-24 14:49:24 +02:00
hridyesh bisht 946a0cd0f5
Changes requested 2025-06-24 14:48:44 +02:00
hridyesh bisht da7b92163f
Removing default value from fleet.yaml 2025-06-24 14:48:44 +02:00
hridyesh bisht 3fa133c662
Fix a typo 2025-06-24 14:48:44 +02:00
hridyesh bisht 411400049a
Adding more information and an example 2025-06-24 14:48:44 +02:00
hridyesh bisht a7bc56420a
Updating rollout 2025-06-24 14:48:44 +02:00
Patrick Seidensal 48ca9c7bc2
Document roll-out strategies
Refers to rancher/fleet#2672
2025-06-24 14:48:44 +02:00
hridyesh bisht 14099741ee
Merge branch 'main' into feat-different-HelmCredentials 2025-06-19 18:07:08 +05:30
hridyesh bisht 5ffa414b43
Fix minor typos 2025-06-19 18:01:53 +05:30
hridyesh bisht d3bcb592b6
Adding info about 3218#issuecomment-2979916581 2025-06-19 17:58:58 +05:30
hridyesh bisht 551366782a
small fix 2025-06-19 16:23:04 +05:30
hridyesh bisht 086f958684
Update docs/oci-storage.md
Co-authored-by: Xavi Garcia <xavi.garcia@suse.com>
2025-06-19 16:21:41 +05:30
hridyesh bisht 8412bb1b56
minor fixes 2025-06-19 15:58:51 +05:30
hridyesh bisht 0e954d6823
Applying DRY 2025-06-19 15:56:12 +05:30
hridyesh bisht 245614fe6b
Merge branch 'update-oci-storage' of https://github.com/kakabisht/fleet-docs into update-oci-storage 2025-06-18 17:18:50 +05:30
hridyesh bisht 948f356da4
Addressing peer feedback 2025-06-18 17:18:38 +05:30
hridyesh bisht 70f0c02322
Update docs/oci-storage.md
Co-authored-by: Xavi Garcia <xavi.garcia@suse.com>
2025-06-18 16:56:26 +05:30
hridyesh bisht 3091206b69
minor fixes 2025-06-17 13:52:24 +05:30
hridyesh bisht 6a64825135
Second set of changes 2025-06-17 13:34:39 +05:30
hridyesh bisht 249a272db7
partial fixes 2025-06-17 12:04:39 +05:30
hridyesh bisht eaae0ced26
Update docs/oci-storage.md
Co-authored-by: Xavi Garcia <xavi.garcia@suse.com>
2025-06-17 10:58:47 +05:30
hridyesh bisht 592f9cf841
Update docs/oci-storage.md
Co-authored-by: Xavi Garcia <xavi.garcia@suse.com>
2025-06-17 10:58:39 +05:30
hridyesh bisht 442fa34108
Update docs/oci-storage.md
Co-authored-by: Xavi Garcia <xavi.garcia@suse.com>
2025-06-17 10:50:16 +05:30
hridyesh bisht 52a99a14d1
Merge branch 'main' into update-oci-storage 2025-06-13 19:10:11 +05:30
hridyesh bisht dfc4c939c6
Update after tech review 2025-06-13 19:09:40 +05:30
hridyesh bisht 47aa6f0eed
Modifying based on peer feedback 2025-06-12 11:59:27 +05:30
Corentin Néau cde698a78d
Document polling for HelmOps (#262)
* Document semantic versioning for HelmOps

That the HelmOp version field now supports semver constraints, which
this documents with links to the spec and to examples of how such
constraints are written and parsed.

* Document polling for HelmOps

The new polling feature for HelmOps is now documented, for users to know
how to enable it and what to expect when it is enabled.

* Clarify HelmOps vs HelmOp

Feedback suggested that the distinction between HelmOps as an idea, and
`HelmOp` as a resource, needed to be expanded upon. This is an attempt
in that direction.
2025-06-11 13:21:39 +02:00
Mario Manno 4c85fb663e
Notes on agent and manager initiated registration (#258) 2025-06-10 16:56:19 +02:00
Mario Manno cc1648198a
Add grafana setup instructions (#261)
Co-authored-by: Mario Manno <mario.manno@suse.com>
2025-06-10 10:42:08 +02:00
Corentin Néau 205ee29fc2
Add comment on default chart values
This clarifies that `values.yaml` files contained in a chart will be
used as default values without needing to be referenced from
`fleet.yaml`.
2025-06-04 14:22:10 +02:00
Corentin Néau 98cda0d3d3
Add note on referencing embedded charts in fleet.yaml
A new note clarifies that embedded charts need to be referenced from a
`fleet.yaml` files if that file lives outside of the chart's directory.
2025-06-04 12:45:28 +02:00
hridyesh bisht 0aaf1dc1b1
Merge branch 'main' into update-oci-storage 2025-06-04 14:05:56 +05:30
hridyesh bisht 3a53abd8f2
Adding information about secrets in OCI Storage 2025-06-04 14:05:05 +05:30
hridyesh bisht acb9c44458
Merge branch 'main' into feat-persona-fleet 2025-05-27 16:16:39 +05:30
kakabisht 7689e3b406 Adding information about persona in fleet docs 2025-05-27 10:45:50 +00:00
Patrick Seidensal 438b62dc17
Add note about limitations of metrics (#247) 2025-05-14 13:04:33 +02:00
Corentin Néau d8a40a70ee
Improve CD definition
This commit tries to clarify that whether Fleet is a continuous
_delivery_ or _deployment_ tool is pretty much open to interpretation,
since many different definitions of both concepts exist.
2025-05-12 17:26:12 +02:00
Corentin Néau 3040eae488
Add glossary to sidebar
This takes the opportunity to fill in empty definitions, apart from
workspaces which is not a concept used much by Fleet.
2025-05-12 17:19:05 +02:00
Corentin Néau 26b6e484c0
Document HelmOps as experimental feature (#242)
This provides basic information around the feature, why it exists, and
how to make use of it.
2025-05-12 14:39:48 +02:00
hridyesh bisht b57d4ca91f
Fixing broken links 2025-05-12 13:39:01 +05:30
Corentin Néau 0b26bc0a1b
Document limitation on Helm charts in git with custom CAs (#244)
This clarifies that, while Helm options support `git::http://`-prefixed
chart URLs, using them will not succeed when pointing to a git
repository using a custom CA bundle.

It takes the opportunity to somewhat reformat the `fleet.yaml`
reference, with collapsible YAML and further details on the main Helm
options being migrated further down the page. This allows better
formatting and should hopefully make that page more readable.
2025-05-09 12:17:24 +02:00
Mario Manno 6dc5255119
Update resource list (#236)
Co-authored-by: Mario Manno <mario.manno@suse.com>
2025-05-05 12:16:53 +02:00
Mario Manno 3b277da39d
Add glossary of Fleet terms (#183)
* Add glossary of Fleet terms

---------

Co-authored-by: Corentin Néau <tan.neau@suse.com>
2025-04-29 15:48:37 +02:00
Corentin Néau 9acf021ea5
Document strict host key checks support (#234)
This provides information about what that feature means and a brief
overview of how it works.
2025-04-25 16:53:01 +02:00
Corentin Néau 453c3df813
Fix links on `fleet-agent` help page (#232)
Those links, previously broken, now properly redirect to subcommands.
2025-04-25 16:08:36 +02:00
Corentin Néau 54bd85ad71
Document Helm values for replica counts (#229)
This provides information on each value and its use, as well as default
values.
2025-04-25 16:08:15 +02:00
Corentin Néau e490d691ef
Update versioned links (#225)
A few links contained hard-coded, and outdated, Rancher version numbers.
2025-04-25 16:07:58 +02:00
Corentin Néau d1cc612696
Add resource ignore example (#220)
This illustrates how to ignore entire resources, adding an example to
the page on bundle diffs.
2025-04-25 16:07:46 +02:00
Corentin Néau df808abb46
Add links to quick start page (#221)
This may help newcomers to gradually find their way towards
documentation covering more sophisticated use cases.
2025-04-25 16:07:14 +02:00
Mario Manno 13c453824d
Add debug/watch troubleshooting info (#219) 2025-04-25 16:05:56 +02:00
Xavi Garcia 70046e2fb3 code review 1 changes 2025-04-25 10:39:45 +02:00
Xavi Garcia e9f2e9f78f Adds user-driven bundle scan docs
Related to: https://github.com/rancher/fleet/pull/3480

Signed-off-by: Xavi Garcia <xavi.garcia@suse.com>
2025-04-25 10:39:45 +02:00
Mario Manno 070ad4568e
Fix target CLI command line arg (#233)
Co-authored-by: Mario Manno <mario.manno@suse.com>
2025-04-17 14:47:39 +02:00
Xavi Garcia fcb6057f05 Adds GitRepo webhook secret documentation
Related to: https://github.com/rancher/fleet/pull/3490

Signed-off-by: Xavi Garcia <xavi.garcia@suse.com>
2025-04-15 17:00:50 +02:00
Mario Manno 9988a768f0
Add link to rancher-config docs (#226)
Co-authored-by: Mario Manno <mario.manno@suse.com>
2025-03-25 16:52:00 +01:00
Corentin Néau c45db1afbd
Fix typo in CA bundle docs (#223)
This removes a superfluous word.
2025-03-21 17:16:23 +01:00
Xavi Garcia ae2b46ab5d Adds deleteNamespace to the GitRepo docs
Signed-off-by: Xavi Garcia <xavi.garcia@suse.com>
2025-03-17 14:08:54 +01:00
Corentin Néau 61ec496cda
Document fallback to Rancher CA bundles if configured (#212)
This clarifies that Rancher CA bundles may be used if they are
configured, although CA bundles specified in a `GitRepo`'s Helm secret
or `cabundle` field will still have precedence over them.
2025-02-18 12:52:27 +01:00
Mario Manno 28fe5e0d43
Fleet yaml is not optional (#218)
This fixes misleading phrasing in the deployment tutorial.
2025-02-12 15:46:56 +01:00
Corentin Néau a51e4a1437
Decrease indentation level for paragraph on credentials in git (#217)
That paragraph belongs one level higher than it was, not being part of
the subsection on private Helm registries.
2025-02-04 11:24:14 +01:00
Alessio Greggi 967aa30910
docs: isolated workspaces (#216)
* docs: isolated workspaces

---------

Signed-off-by: Alessio Greggi <alessio.greggi@suse.com>
2025-02-03 16:23:58 +01:00
Patrick Seidensal 0828b6679b
Fix typo (#215)
* Fix typo

* Fix typo, add type to code block
2025-02-03 14:18:49 +01:00
Mario Manno fafca9bc24 Fix crawler errors
* Links with / don't exist, browser has a workaround, crawler does not.
  Checked with curl.
* `cmd/docs/generate-cli-docs.go` generates invalid links between root
  and sub command. Apparently only if folder name equals root cmd name.
2025-02-03 14:08:49 +01:00
Mario Manno afffbc0dee
Drift correction indendation suggested it goes below targets: (#211) 2025-01-22 11:50:52 +01:00
Mario Manno b1a86ed823
Update ref-configuration.md 2024-12-20 15:49:50 +01:00
Mario Manno f1fae5ca0b Add info about rancher-config 2024-12-20 15:34:40 +01:00
Corentin Néau bf3da29b8a
Fix formatting of troubleshooting intro (#208)
This fixes indenting for nested lists to be treated as such, instead of
appearing as code blocks.
2024-12-17 11:18:26 +01:00
Mario Manno 349c37f7a8
Add info on default resources (#205)
Add info on default resources

Co-authored-by: Corentin Néau <tan.neau@suse.com>
2024-12-04 12:08:34 +01:00
Mario Manno f86eb63ed2
Give some guidance on Fleet uninstallation (#207)
Give some guidance on Fleet uninstallation


Co-authored-by: Corentin Néau <tan.neau@suse.com>
2024-12-04 12:08:00 +01:00
Mario Manno ce4de32097 Update observability docs 2024-11-13 18:55:43 +01:00
Mario Manno 656266bb54 Update CLI arguments 2024-11-13 18:47:24 +01:00
Mario Manno df9667cc9c Add observability information 2024-11-13 18:35:11 +01:00
Mario Manno 4108821efe Add values templating information 2024-11-13 18:34:47 +01:00
Mario Manno c46955e07c Add gitrepo label info 2024-11-13 17:58:32 +01:00
MARCO 27a8f26c50
docs: fix missing charts (#201)
This replaces placeholders which would be missing from fleetVersions.js
with static text, as already used in the default install instructions.
2024-10-31 10:53:55 +01:00
Mario Manno 9e36ff0554 Add note to oci storage
Try to increase search result ranking of this page
2024-10-28 11:47:34 +01:00
Mario Manno 6a8d9da8db
Merge pull request #200 from rancher/troubleshoot-and-values
Add notes regarding troubleshooting and helm values
2024-10-25 11:15:10 +02:00
Mario Manno 5d2a627cfa
Merge pull request #189 from rancher/add-troubleshooting-intro
Add troubleshooting intro
2024-10-25 11:14:58 +02:00
Mario Manno 2619563098 Add notes regarding troubleshooting and helm values 2024-10-25 11:13:45 +02:00
Mario Manno c1e456bd9a
Add info about target customizations in bundles (#185)
This clarifies how targets can be defined and customised at bundle level.
2024-10-02 10:59:43 +02:00
github-actions[bot] e492ff2bde
Update API docs (#195)
Co-authored-by: thardeck <thardeck@users.noreply.github.com>
2024-10-01 16:46:45 +02:00
Jan e50f7ef3e0
Fix ociRegistry reference field naming (#190)
This now references the actual field name.
2024-09-30 17:38:46 +02:00
Tim Hardeck 3992df15f4
Update ref-crds.md from main (#188)
* Update ref-crds.md from main

* Update ref-crds for Fleet 0.10.x

* Update ref-crds for Fleet 0.9.x
2024-09-25 15:19:21 +02:00
Corentin Néau ff1e2f8823
Add troubleshooting intro
This provides an overview of where and when to gather clues about what
Fleet may be doing wrong, before the section explaining _how_ to do so.
2024-09-20 17:39:39 +02:00
Tim Hardeck 06f75b4073
Improve Fleet YAML struct reference (#186)
* Improve Fleet YAML struct reference

* Update docs/ref-fleet-yaml.md

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

---------

Co-authored-by: Corentin Néau <tan.neau@suse.com>
2024-09-20 15:54:59 +02:00
Mario Manno db8ef67dcd Add information about credentials in git 2024-09-09 10:26:56 +02:00
Mario Manno ab090b0623 Warn about removing workspace namespaces 2024-09-06 15:49:57 +02:00
Mario Manno d147f281a9
Merge pull request #177 from rancher/cluster-registration-token
Add ownership from cluster registration
2024-09-06 10:33:35 +02:00
Mario Manno 81f3182c02
Merge pull request #174 from rancher/remove-disable-gitops
Remove mentions to `--disable-gitops` in 0.10+
2024-09-06 10:29:15 +02:00
Mario Manno 1bd9d86335
Merge pull request #173 from jiwonhu/main
Elaborate on API_SERVER_URL in agent-initiated cluster reg
2024-09-06 10:28:48 +02:00
Xavi Garcia 9931b4e8a9 Review changes
Signed-off-by: Xavi Garcia <xavi.garcia@suse.com>
2024-09-05 15:16:58 +02:00