fleet.yaml

The fleet.yaml file adds options to a bundle. Any directory with a fleet.yaml is automatically turned into bundle.

For more information on how to use the fleet.yaml to customize bundles see Git Repository Contents.

The content of the fleet.yaml corresponds to the struct at pkg/bundlereader/read.go, which contains the BundleSpec.

Reference

fleet.yaml

  1. # The default namespace to be applied to resources. This field is not used to
  2. # enforce or lock down the deployment to a specific namespace, but instead
  3. # provide the default value of the namespace field if one is not specified
  4. # in the manifests.
  5. # Default: default
  6. defaultNamespace: default
  8. # All resources will be assigned to this namespace and if any cluster scoped
  9. # resource exists the deployment will fail.
  10. # Default: ""
  11. namespace: default
  13. # namespaceLabels are labels that will be appended to the namespace created by Fleet.
  14. namespaceLabels:
  15.   key: value
  16. # namespaceAnnotations are annotations that will be appended to the namespace created by Fleet.
  17. namespaceAnnotations:
  18.   key: value
  20. # Optional map of labels, that are set at the bundle and can be used in a
  21. # dependsOn.selector
  22. labels:
  23.   key: value
  25. kustomize:
  26.   # Use a custom folder for kustomize resources. This folder must contain
  27.   # a kustomization.yaml file.
  28.   dir: ./kustomize
  30. helm:
  31.   ### These options control how "fleet apply" downloads the chart
  32.   #
  33.   # Use a custom location for the Helm chart. This can refer to any go-getter URL or
  34.   # OCI registry based helm chart URL e.g. "oci://ghcr.io/fleetrepoci/guestbook".
  35.   # This allows one to download charts from most any location.  Also know that
  36.   # go-getter URL supports adding a digest to validate the download. If repo
  37.   # is set below this field is the name of the chart to lookup
  38.   chart: ./chart
  39.   # A https URL to a Helm repo to download the chart from. It's typically easier
  40.   # to just use `chart` field and refer to a tgz file.  If repo is used the
  41.   # value of `chart` will be used as the chart name to lookup in the Helm repository.
  42.   repo: https://charts.rancher.io
  43.   # The version of the chart or semver constraint of the chart to find. If a constraint
  44.   # is specified it is evaluated each time git changes.
  45.   # The version also determines which chart to download from OCI registries.
  46.   version: 0.1.0
  48.   ### These options only work for helm-type bundles
  49.   #
  50.   # Any values that should be placed in the `values.yaml` and passed to helm during
  51.   # install.
  52.   values:
  53.     any-custom: value
  54.   # All labels on Rancher clusters are available using global.fleet.clusterLabels.LABELNAME
  55.   # These can now be accessed directly as variables
  56.   # The variable's value will be an empty string if the referenced cluster label does not
  57.   # exist on the targeted cluster
  58.     variableName: global.fleet.clusterLabels.LABELNAME
  59.   # It is possible to specify the keys and values as go template strings for
  60.   # advanced templating needs. Most of the functions from the sprig templating
  61.   # library are available. Note, if the functions output changes with every
  62.   # call, e.g. `uuidv4`, the bundle will get redeployed.
  63.   # The template context has following keys.
  64.   # `.ClusterValues` are retrieved from target cluster's `spec.templateValues`
  65.   # `.ClusterLabels` and `.ClusterAnnotations` are the labels and annoations in the cluster resource.
  66.   # `.ClusterName` as the fleet's cluster resource name.
  67.   # `.ClusterNamespace` as the namespace in which the cluster resource exists.
  68.   # Note: The fleet.yaml must be valid yaml. Templating uses ${ } as delims,
  69.   #       unlike helm which uses {{ }}.
  70.     templatedLabel: "${ .ClusterLabels.LABELNAME }-foo"
  71.     valueFromEnv:
  72.       "${ .ClusterLabels.ENV }": ${ .ClusterValues.someValue | upper | quote }
  73.   # Path to any values files that need to be passed to helm during install
  74.   valuesFiles:
  75.     - values1.yaml
  76.     - values2.yaml
  77.   # Allow to use values files from configmaps or secrets defined in the downstream clusters
  78.   valuesFrom:
  79.   - configMapKeyRef:
  80.       name: configmap-values
  81.       # default to namespace of bundle
  82.       namespace: default
  83.       key: values.yaml
  84.   - secretKeyRef:
  85.       name: secret-values
  86.       namespace: default
  87.       key: values.yaml
  89.   ### These options control how fleet-agent deploys the bundle, they also apply for kustomize- and manifest-style bundles.
  90.   #
  91.   # A custom release name to deploy the chart as. If not specified a release name
  92.   # will be generated by combining the invoking GitRepo.name + GitRepo.path.
  93.   releaseName: my-release
  94.   # Makes helm skip the check for its own annotations
  95.   takeOwnership: false
  96.   # Override immutable resources. This could be dangerous.
  97.   force: false
  98.   # Set the Helm --atomic flag when upgrading
  99.   atomic: false
  100.   # Disable go template pre-processing on the fleet values
  101.   disablePreProcess: false
  102.   # Disable DNS resolution in Helm's template functions
  103.   disableDNS: false
  104.   # Skip evaluation of the values.schema.json file
  105.   skipSchemaValidation: false
  106.   # if set and timeoutSeconds provided, will wait until all Jobs have been completed before marking the GitRepo as ready.
  107.   # It will wait for as long as timeoutSeconds
  108.   waitForJobs: true
  110. # A paused bundle will not update downstream clusters but instead mark the bundle
  111. # as OutOfSync. One can then manually confirm that a bundle should be deployed to
  112. # the downstream clusters.
  113. # Default: false
  114. paused: false
  116. rolloutStrategy:
  117.     # A number or percentage of clusters that can be unavailable during an update
  118.     # of a bundle. This follows the same basic approach as a deployment rollout
  119.     # strategy. Once the number of clusters meets unavailable state update will be
  120.     # paused. Default value is 100% which doesn't take effect on update.
  121.     # default: 100%
  122.     maxUnavailable: 15%
  123.     # A number or percentage of cluster partitions that can be unavailable during
  124.     # an update of a bundle.
  125.     # default: 0
  126.     maxUnavailablePartitions: 20%
  127.     # A number of percentage of how to automatically partition clusters if not
  128.     # specific partitioning strategy is configured.
  129.     # default: 25%
  130.     autoPartitionSize: 10%
  131.     # A list of definitions of partitions.  If any target clusters do not match
  132.     # the configuration they are added to partitions at the end following the
  133.     # autoPartitionSize.
  134.     partitions:
  135.       # A user friend name given to the partition used for Display (optional).
  136.       # default: ""
  137.     - name: canary
  138.       # A number or percentage of clusters that can be unavailable in this
  139.       # partition before this partition is treated as done.
  140.       # default: 10%
  141.       maxUnavailable: 10%
  142.       # Selector matching cluster labels to include in this partition
  143.       clusterSelector:
  144.         matchLabels:
  145.           env: prod
  146.       # A cluster group name to include in this partition
  147.       clusterGroup: agroup
  148.       # Selector matching cluster group labels to include in this partition
  149.       clusterGroupSelector:
  150.         clusterSelector:
  151.           matchLabels:
  152.             env: prod
  154. # Target customization are used to determine how resources should be modified per target
  155. # Targets are evaluated in order and the first one to match a cluster is used for that cluster.
  156. targetCustomizations:
  157. # The name of target. If not specified a default name of the format "target000"
  158. # will be used. This value is mostly for display
  159. - name: prod
  160.   # Custom namespace value overriding the value at the root
  161.   namespace: newvalue
  162.   # Custom defaultNamespace value overriding the value at the root
  163.   defaultNamespace: newdefaultvalue
  164.   # Custom kustomize options overriding the options at the root
  165.   kustomize: {}
  166.   # Custom Helm options override the options at the root
  167.   helm: {}
  168.   # If using raw YAML these are names that map to overlays/{name} that will be used
  169.   # to replace or patch a resource. If you wish to customize the file ./subdir/resource.yaml
  170.   # then a file ./overlays/myoverlay/subdir/resource.yaml will replace the base file.
  171.   # A file named ./overlays/myoverlay/subdir/resource_patch.yaml will patch the base file.
  172.   # A patch can in JSON Patch or JSON Merge format or a strategic merge patch for builtin
  173.   # Kubernetes types. Refer to "Raw YAML Resource Customization" below for more information.
  174.   yaml:
  175.     overlays:
  176.     - custom2
  177.     - custom3
  178.   # A selector used to match clusters.  The structure is the standard
  179.   # metav1.LabelSelector format. If clusterGroupSelector or clusterGroup is specified,
  180.   # clusterSelector will be used only to further refine the selection after
  181.   # clusterGroupSelector and clusterGroup is evaluated.
  182.   clusterSelector:
  183.     matchLabels:
  184.       env: prod
  185.   # A selector used to match a specific cluster by name. When using Fleet in
  186.   # Rancher, make sure to put the name of the clusters.fleet.cattle.io resource.
  187.   clusterName: dev-cluster
  188.   # A selector used to match cluster groups.
  189.   clusterGroupSelector:
  190.     matchLabels:
  191.       region: us-east
  192.   # A specific clusterGroup by name that will be selected
  193.   clusterGroup: group1
  194.   # Resources will not be deployed in the matched clusters if doNotDeploy is true.
  195.   doNotDeploy: false
  197. # dependsOn allows you to configure dependencies to other bundles. The current bundle
  198. # will only be deployed, after all dependencies are deployed and in a Ready state.
  199. dependsOn:
  200.   # Format: <GITREPO-NAME>-<BUNDLE_PATH> with all path separators replaced by "-"
  201.   # Example: GitRepo name "one", Bundle path "/multi-cluster/hello-world" => "one-multi-cluster-hello-world"
  202.   # Note: Bundle names are limited to 53 characters long. If longer they will be shortened:
  203.   # opni-fleet-examples-fleets-opni-ui-plugin-operator-crd becomes opni-fleet-examples-fleets-opni-ui-plugin-opera-021f7
  204.   - name: one-multi-cluster-hello-world
  205.   # Select bundles to depend on based on their label.
  206.   - selector:
  207.       matchLabels:
  208.         app: weak-monkey
  210. # Ignore fields when monitoring a Bundle. This can be used when Fleet thinks some conditions in Custom Resources
  211. # makes the Bundle to be in an error state when it shouldn't.
  212. ignore:
  213.   # Conditions to be ignored
  214.   conditions:
  215.   # In this example a condition will be ignored if it contains {"type": "Active", "status", "False"}
  216.   - type: Active
  217.     status: "False"
  219. # Override targets defined in the GitRepo. The Bundle will not have any targets from the GitRepo if overrideTargets is provided.
  220. overrideTargets:
  221.   - clusterSelector:
  222.       matchLabels:
  223.         env: dev