rancher
/
fleet-docs
mirror of https://github.com/rancher/fleet-docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add note about releaseName 

Copied text from existing PR in rancher/fleet

closes https://github.com/rancher/fleet/pull/720
This commit is contained in:
Mario Manno 2022-12-21 11:48:32 +01:00
parent 917bd22b3e
commit 6065c7f35b
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/gitrepo-structure.md
View File

@ -2,6 +2,10 @@
Fleet will create bundles from a git repository. This happens either explicitly by specifying paths, or when a `fleet.yaml` is found. Fleet will create bundles from a git repository. This happens either explicitly by specifying paths, or when a `fleet.yaml` is found.
Each bundle is created from paths in a GitRepo and modified further by reading the discovered `fleet.yaml` file.
Bundle lifecycles are tracked between releases by the helm releaseName field added to each bundle. If the releaseName is not
specified within fleet.yaml it is generated from `GitRepo.name + path`. Long names are truncated and a `-<hash>` prefix is added.
**The git repository has no explicitly required structure.** It is important **The git repository has no explicitly required structure.** It is important
to realize the scanned resources will be saved as a resource in Kubernetes so to realize the scanned resources will be saved as a resource in Kubernetes so
you want to make sure the directories you are scanning in git do not contain you want to make sure the directories you are scanning in git do not contain
@ -80,7 +84,7 @@ helm:
# value of `chart` will be used as the chart name to lookup in the Helm repository. # value of `chart` will be used as the chart name to lookup in the Helm repository.
repo: https://charts.rancher.io repo: https://charts.rancher.io
# A custom release name to deploy the chart as. If not specified a release name # A custom release name to deploy the chart as. If not specified a release name
# will be generated. # will be generated by combining the invoking GitRepo.name + GitRepo.path.
releaseName: my-release releaseName: my-release
# The version of the chart or semver constraint of the chart to find. If a constraint # The version of the chart or semver constraint of the chart to find. If a constraint
# is specified it is evaluated each time git changes. # is specified it is evaluated each time git changes.