Document bundle naming override

Overriding a bundle's name can be done through the `name` field in a
`fleet.yaml` file.
This commit is contained in:
Corentin Néau 2025-07-30 11:09:12 +02:00
parent 89c59a22b1
commit 24530291ce
No known key found for this signature in database
GPG Key ID: 4E10825BFE040608
2 changed files with 8 additions and 0 deletions

View File

@ -6,6 +6,9 @@ Each bundle is created from paths in a GitRepo and modified further by reading t
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.
By default, bundle names will also be generated from the GitRepo's name and the path from which the bundle is created.
However, a bundle's name can be overridden by using the `name` field in a `fleet.yaml` file.
**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
you want to make sure the directories you are scanning in git do not contain

View File

@ -40,6 +40,11 @@ namespaceLabels:
namespaceAnnotations:
key: value
# Name of the bundle. If not specified, the bundle name will be computed based
# on the GitRepo's name, and the path from which the bundle is created.
# Default: ""
name: my-great-bundle
# Optional map of labels, that are set at the bundle and can be used in a
# dependsOn.selector
labels: