da7d0f5d1f
Fixing minor typos
2025-06-24 14:49:26 +02:00
dcec8f71d0
Second set of changes
2025-06-24 14:49:26 +02:00
251df276a9
First set of changes.
2025-06-24 14:49:24 +02:00
946a0cd0f5
Changes requested
2025-06-24 14:48:44 +02:00
da7b92163f
Removing default value from fleet.yaml
2025-06-24 14:48:44 +02:00
3fa133c662
Fix a typo
2025-06-24 14:48:44 +02:00
411400049a
Adding more information and an example
2025-06-24 14:48:44 +02:00
a7bc56420a
Updating rollout
2025-06-24 14:48:44 +02:00
48ca9c7bc2
Document roll-out strategies
...
Refers to rancher/fleet#2672
2025-06-24 14:48:44 +02:00
14099741ee
Merge branch 'main' into feat-different-HelmCredentials
2025-06-19 18:07:08 +05:30
5ffa414b43
Fix minor typos
2025-06-19 18:01:53 +05:30
d3bcb592b6
Adding info about 3218#issuecomment-2979916581
2025-06-19 17:58:58 +05:30
551366782a
small fix
2025-06-19 16:23:04 +05:30
086f958684
Update docs/oci-storage.md
...
Co-authored-by: Xavi Garcia <xavi.garcia@suse.com>
2025-06-19 16:21:41 +05:30
8412bb1b56
minor fixes
2025-06-19 15:58:51 +05:30
0e954d6823
Applying DRY
2025-06-19 15:56:12 +05:30
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
948f356da4
Addressing peer feedback
2025-06-18 17:18:38 +05:30
70f0c02322
Update docs/oci-storage.md
...
Co-authored-by: Xavi Garcia <xavi.garcia@suse.com>
2025-06-18 16:56:26 +05:30
3091206b69
minor fixes
2025-06-17 13:52:24 +05:30
6a64825135
Second set of changes
2025-06-17 13:34:39 +05:30
249a272db7
partial fixes
2025-06-17 12:04:39 +05:30
eaae0ced26
Update docs/oci-storage.md
...
Co-authored-by: Xavi Garcia <xavi.garcia@suse.com>
2025-06-17 10:58:47 +05:30
592f9cf841
Update docs/oci-storage.md
...
Co-authored-by: Xavi Garcia <xavi.garcia@suse.com>
2025-06-17 10:58:39 +05:30
442fa34108
Update docs/oci-storage.md
...
Co-authored-by: Xavi Garcia <xavi.garcia@suse.com>
2025-06-17 10:50:16 +05:30
52a99a14d1
Merge branch 'main' into update-oci-storage
2025-06-13 19:10:11 +05:30
dfc4c939c6
Update after tech review
2025-06-13 19:09:40 +05:30
47aa6f0eed
Modifying based on peer feedback
2025-06-12 11:59:27 +05:30
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
4c85fb663e
Notes on agent and manager initiated registration ( #258 )
2025-06-10 16:56:19 +02:00
cc1648198a
Add grafana setup instructions ( #261 )
...
Co-authored-by: Mario Manno <mario.manno@suse.com>
2025-06-10 10:42:08 +02:00
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
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
0aaf1dc1b1
Merge branch 'main' into update-oci-storage
2025-06-04 14:05:56 +05:30
3a53abd8f2
Adding information about secrets in OCI Storage
2025-06-04 14:05:05 +05:30
acb9c44458
Merge branch 'main' into feat-persona-fleet
2025-05-27 16:16:39 +05:30
7689e3b406
Adding information about persona in fleet docs
2025-05-27 10:45:50 +00:00
438b62dc17
Add note about limitations of metrics ( #247 )
2025-05-14 13:04:33 +02:00
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
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
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
b57d4ca91f
Fixing broken links
2025-05-12 13:39:01 +05:30
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
6dc5255119
Update resource list ( #236 )
...
Co-authored-by: Mario Manno <mario.manno@suse.com>
2025-05-05 12:16:53 +02:00
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
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
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
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
e490d691ef
Update versioned links ( #225 )
...
A few links contained hard-coded, and outdated, Rancher version numbers.
2025-04-25 16:07:58 +02:00
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
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
13c453824d
Add debug/watch troubleshooting info ( #219 )
2025-04-25 16:05:56 +02:00
70046e2fb3
code review 1 changes
2025-04-25 10:39:45 +02:00
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
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
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
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
c45db1afbd
Fix typo in CA bundle docs ( #223 )
...
This removes a superfluous word.
2025-03-21 17:16:23 +01:00
ae2b46ab5d
Adds deleteNamespace to the GitRepo docs
...
Signed-off-by: Xavi Garcia <xavi.garcia@suse.com>
2025-03-17 14:08:54 +01:00
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
28fe5e0d43
Fleet yaml is not optional ( #218 )
...
This fixes misleading phrasing in the deployment tutorial.
2025-02-12 15:46:56 +01:00
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
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
0828b6679b
Fix typo ( #215 )
...
* Fix typo
* Fix typo, add type to code block
2025-02-03 14:18:49 +01:00
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
afffbc0dee
Drift correction indendation suggested it goes below targets: ( #211 )
2025-01-22 11:50:52 +01:00
b1a86ed823
Update ref-configuration.md
2024-12-20 15:49:50 +01:00
f1fae5ca0b
Add info about rancher-config
2024-12-20 15:34:40 +01:00
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
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
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
ce4de32097
Update observability docs
2024-11-13 18:55:43 +01:00
656266bb54
Update CLI arguments
2024-11-13 18:47:24 +01:00
df9667cc9c
Add observability information
2024-11-13 18:35:11 +01:00
4108821efe
Add values templating information
2024-11-13 18:34:47 +01:00
c46955e07c
Add gitrepo label info
2024-11-13 17:58:32 +01:00
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
9e36ff0554
Add note to oci storage
...
Try to increase search result ranking of this page
2024-10-28 11:47:34 +01:00
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
5d2a627cfa
Merge pull request #189 from rancher/add-troubleshooting-intro
...
Add troubleshooting intro
2024-10-25 11:14:58 +02:00
2619563098
Add notes regarding troubleshooting and helm values
2024-10-25 11:13:45 +02:00
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
e492ff2bde
Update API docs ( #195 )
...
Co-authored-by: thardeck <thardeck@users.noreply.github.com>
2024-10-01 16:46:45 +02:00
e50f7ef3e0
Fix ociRegistry reference field naming ( #190 )
...
This now references the actual field name.
2024-09-30 17:38:46 +02:00
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
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
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
db8ef67dcd
Add information about credentials in git
2024-09-09 10:26:56 +02:00
ab090b0623
Warn about removing workspace namespaces
2024-09-06 15:49:57 +02:00
d147f281a9
Merge pull request #177 from rancher/cluster-registration-token
...
Add ownership from cluster registration
2024-09-06 10:33:35 +02:00
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
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
9931b4e8a9
Review changes
...
Signed-off-by: Xavi Garcia <xavi.garcia@suse.com>
2024-09-05 15:16:58 +02:00
9612ae4f84
Adds experimental features and OCI storage
...
Signed-off-by: Xavi Garcia <xavi.garcia@suse.com>
2024-09-05 15:16:58 +02:00
af3fb01b7c
Remove mentions to `--disable-gitops` in 0.10+
...
That flag no longer exists from Fleet 0.10 onwards.
2024-09-04 11:19:17 +02:00
a0afc4df72
Document node selectors for sharding ( #176 )
...
This updates sharding documentation to take node selectors, and the new
sharding parameters syntax, into account.
2024-09-02 10:04:37 +02:00
901c0d7dc9
Update docs/cluster-registration.md
...
Co-authored-by: Mario Manno <mario.manno@gmail.com>
2024-08-26 18:07:30 +08:00
92c9614636
Add ownership from cluster registration
2024-08-22 10:14:13 +02:00
33bd153576
Update resource status page ( #170 )
2024-08-22 09:39:48 +02:00
5a350d3a43
Rename fleet-manager as fleetcontroller in CLI
...
This is done on versions 0.10 onwards, to reflect current Fleet
terminology.
2024-08-21 14:46:44 +02:00
c88e7bd4f8
Replace 'Fleet manager' architecture references with 'Fleet controller'
...
This is more consistent with current Fleet terminology.
2024-08-21 14:46:22 +02:00
bb1df2dd9a
Elaborate on api-server-url in agent intiated registration
...
- Elaborate on what value to feed and what not on API_SERVER_URL to avoid hitting the issue https://github.com/rancher/fleet/issues/68
- Moved a namespace caution to the right place, right before helm install cmd
2024-08-04 15:19:48 +08:00
4c6a4222ee
Fix broken link in Quick Start page ( #172 )
2024-08-01 11:45:01 +02:00
51833b06b3
Merge pull request #166 from p-se/add-graph-workload-namespaces
...
Add graph to explain configuration of workload namespaces better
2024-07-19 13:34:55 +02:00
686f1ac0e7
Shorten and clarify cluster registration namespace docs
2024-07-19 12:20:57 +02:00
170e080d64
Combine status reference pages
2024-07-16 16:19:32 +02:00
afb8ff989a
Add graph about workload namespace configuration
...
- Add a graph about workload namespace configuration.
- This change also divides the structure of the namespaces explanation
page into "workload namespaces" and "fleet namespaces" for better
readability and more clarity. By doing that, another layer of headers
is introduced, for which the TOC on the right hand side has been
adapted to show the same details as before.
- The source of the added graph is added in the `src/img` folder as
Mermaid code.
- Also, paragraphs have been wrapped to a certain max width.
2024-07-15 15:09:19 +02:00
b82c54f855
Formatting
2024-07-10 12:57:53 +02:00
f8cc15d539
Don't capitalize namespace names
2024-07-10 12:56:44 +02:00
18e3e3e868
Note about target/deploy namespace ( #165 )
2024-07-09 16:26:53 +02:00
155bd35e88
Adding documentation to troubleshoot helm error while deploying multiple times ressources with the same releaseName ( #163 )
2024-07-09 14:32:19 +02:00
642b018dbf
Visually update fleet.yaml reference page ( #164 )
...
- Fixed max width
- More or less consistent document style
- Spacing between options
- Generally more line breaks
2024-07-09 14:31:58 +02:00
e6aaa2138e
Adds a reference to OCI vs Semver and the '+' character
...
Signed-off-by: Xavi Garcia <xavi.garcia@suse.com>
2024-07-03 08:10:29 +02:00
2bbd73ae55
Introduce reference documentation for resource counts and resources list in status
2024-06-27 14:03:19 +02:00
7f3299f2c6
Fix internal links ( #157 )
...
This fixes a couple of links pointing to the `rancher/fleet` repository.
2024-06-21 14:58:50 +02:00
c248df4f33
Update gitrepo-add.md
...
Added in an example yaml config when using a private git repo. This would eliminate confusion as in https://github.com/rancher/fleet/issues/2495
2024-06-12 12:48:41 +02:00
835e961612
Fix `fleet apply` command description
...
That command does not render bundles into Kubernetes resources, but
rather creates bundles from directories, which can be either output or
applied on a cluster.
2024-06-03 13:25:56 +02:00
4e47f5ecb8
Fix typo and add documentation ( #150 )
2024-05-29 10:37:48 +02:00
464f7d793e
Update sharding label in docs ( #149 )
2024-05-29 10:37:31 +02:00
a83bfd92e5
Fix typos in registration reference
2024-05-21 17:15:57 +02:00
1257366719
Update cluster registration reference ( #147 )
2024-05-21 16:28:13 +02:00
d0d3d030e7
Merge pull request #133 from matteotumiati/patch-1
...
Included Azure DevOps as provider for Rancher webhooks
2024-05-19 21:00:42 +02:00
226d429019
fix: add generic changelog for next release
...
Signed-off-by: Olivier Vernin <olivier.vernin@suse.com>
2024-05-15 11:17:55 +02:00
8b339529e1
included Azure DevOps as provider for rancher webhooks
2024-05-14 11:56:52 +02:00
dfd4ab3e09
Adding disableDependencyUpdate option to fleet.yaml
...
Signed-off-by: Xavi Garcia <xavi.garcia@suse.com>
2024-05-14 11:09:49 +02:00
ac00a7bb5e
Add disablePolling to the docs
...
Refers: https://github.com/rancher/fleet/issues/2394
Signed-off-by: Xavi Garcia <xavi.garcia@suse.com>
2024-05-07 11:12:22 +02:00
3c3d907ab8
Remove CLI args, which are non-functional
2024-05-02 10:45:51 +02:00
a53da62a64
Add docs on the CLI bundle commands
2024-05-02 10:45:34 +02:00
635a97ae4b
Add Rancher example multi-user doc ( #127 )
...
Add Rancher multi-user doca
2024-04-26 11:29:37 +02:00
1055f1106d
Update CLI docs
2024-04-25 17:47:06 +02:00
6865c5e25c
Add docs for static sharding
...
This commit documents static sharding support in terms of installation
and use.
2024-04-23 12:28:59 +02:00
511015ed5a
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-23 11:04:50 +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
hridyesh bisht