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