Rancher Fleet

0.8

Schema URL

https://catalog.lintel.tools/schemas/schemastore/rancher-fleet/versions/0.8.json
← Back to Rancher Fleet
Type: object

The driving file of a Fleet bundle

Properties

defaultNamespace nullable-string

The default namespace to be applied to resources. This field is not used to enforce or lock down the deployment to a specific namespace, but instead provide the default value of the namespace field if one is not specified in the manifests. Default: default

dependsOn array | null

An array of dependencies to other Bundles.

diff object

An array of diff options to consider when comparing the current state of the bundle to the desired one.

1 nested properties
comparePatches object[]

An array of compare patches; how the diff should be calculated and eventually ignored. See ref: https://fleet.rancher.io/next/ref-crds#comparepatch

helm object | null
14 nested properties
atomic boolean

Set the Helm --atomic flag when upgrading. Default: false

chart string

Use a custom location for the Helm chart. This can refer to any go-getter URL, OCI registry based helm chart URL e.g. "oci://ghcr.io/fleetrepoci/guestbook" or a local/remote tgz file. This allows one to download charts from most any location. Also know that go-getter URL supports adding a digest to validate the download. If repo is set below this field is the name of the chart to lookup

disablePreProcess boolean

Disable go template pre-processing on the fleet values. Default: false

force boolean

Set the Helm --force flag when upgrading. This could be dangerous (sic). Default: false

maxHistory integer

Set the Helm --max-history flag when upgrading

releaseName string

A custom release name to deploy the chart as. If not specified a release name will be generated by combining the invoking GitRepo.name + GitRepo.path

maxLength=53pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
repo string

A https URL to a Helm repo to download the chart from. If repo is used the value of chart will be used as the chart name to lookup in the Helm repository

Examples: "https://charts.rancher.io"
takeOwnership boolean

Makes helm skip the check for its own annotations. Default: false

Default: false
timeoutSeconds integer

Set the Helm --timeout flag when upgrading.

values object

Any values that should be placed in the values.yaml and passed to helm during install. Cluster labels can also be used here, see https://fleet.rancher.io/next/gitrepo-structure#reference for more info

Examples: "{"replicaCount": 2}", "{"replicaCount": 2, "image": {"tag": "v1.0.0"}}"
valuesFiles string[]

Path to any values files that need to be passed to helm during install

valuesFrom object[]

An array of of configmap or secrets references defined in the downstream clusters to get values for the chart.

version string

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. The version also determines which chart to download from OCI registries

waitForJobs boolean

Wait for all jobs to complete before marking the GitRepo as ready. A timeoutSeconds duration must be set when using. Default: true

kustomize object | null
1 nested properties
dir string

Custom folder for kustomize resources. This folder must contain a kustomization.yaml file. Path is relative to repository root

labels nullable-object

Labels to apply to the bundle. These labels can be used to select bundles by using the dependsOn keyword

namespace nullable-string

All resources will be assigned to this namespace and if any cluster scoped resource exists the deployment will fail. Default: ""

namespaceAnnotations object

Annotations to apply to the namespace created by Fleet

namespaceLabels object

Labels to apply to the namespace created by Fleet

paused nullable-boolean

A paused bundle will not update downstream clusters but instead mark the bundle as OutOfSync. One can then manually confirm that a bundle should be deployed to the downstream clusters. Default: false

rolloutStrategy object | null
4 nested properties
autoPartitionSize string

A number of percentage of how to automatically partition clusters if not specific partitioning strategy is configured. Default: 25%

maxUnavailable string

A number or percentage of clusters that can be unavailable during an update of a bundle. This follows the same basic approach as a deployment rollout strategy. Once the number of clusters meets unavailable state update will be paused. Default value is 100% which doesn't take effect on update. Default: 100%

maxUnavailablePartitions string

A number or percentage of cluster partitions that can be unavailable during an update of a bundle. Default: 0

partitions object[]

An array of definitions of partitions. If any target clusters do not match the configuration they are added to partitions at the end following the autoPartitionSize

serviceAccount nullable-string

The Service account which will be used for the BundleDeployments. Default: ""

targetCustomizations array | null

Target customization are used to determine how resources should be modified per target. Targets are evaluated in order and the first one to match a cluster is used for that cluster

imageScans array | null

ImageScans is An array of images repositories to scan for, so the corresponding repositories may be automatically updated with the specified image

ignore object

Ignore options when monitoring a Bundle. This can be used when Fleet thinks some conditions in Custom Resources makes the Bundle to be in an error state when it shouldn't.

1 nested properties
conditions array

Conditions to be ignored

overrideTargets selector[]

Override targets defined in the GitRepo. The Bundle will not have any targets from the GitRepo if overrideTargets is provided.

Definitions

selector object | null

A selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty selector matches all objects

matchExpressions object[]

matchExpressions is An array of label selector requirements. The requirements are ANDed

matchLabels Record<string, string>

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed

diff object

An array of diff options to consider when comparing the current state of the bundle to the desired one.

comparePatches object[]

An array of compare patches; how the diff should be calculated and eventually ignored. See ref: https://fleet.rancher.io/next/ref-crds#comparepatch

helm object | null
atomic boolean

Set the Helm --atomic flag when upgrading. Default: false

chart string

Use a custom location for the Helm chart. This can refer to any go-getter URL, OCI registry based helm chart URL e.g. "oci://ghcr.io/fleetrepoci/guestbook" or a local/remote tgz file. This allows one to download charts from most any location. Also know that go-getter URL supports adding a digest to validate the download. If repo is set below this field is the name of the chart to lookup

disablePreProcess boolean

Disable go template pre-processing on the fleet values. Default: false

force boolean

Set the Helm --force flag when upgrading. This could be dangerous (sic). Default: false

maxHistory integer

Set the Helm --max-history flag when upgrading

releaseName string

A custom release name to deploy the chart as. If not specified a release name will be generated by combining the invoking GitRepo.name + GitRepo.path

maxLength=53pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
repo string

A https URL to a Helm repo to download the chart from. If repo is used the value of chart will be used as the chart name to lookup in the Helm repository

Examples: "https://charts.rancher.io"
takeOwnership boolean

Makes helm skip the check for its own annotations. Default: false

Default: false
timeoutSeconds integer

Set the Helm --timeout flag when upgrading.

values object

Any values that should be placed in the values.yaml and passed to helm during install. Cluster labels can also be used here, see https://fleet.rancher.io/next/gitrepo-structure#reference for more info

Examples: "{"replicaCount": 2}", "{"replicaCount": 2, "image": {"tag": "v1.0.0"}}"
valuesFiles string[]

Path to any values files that need to be passed to helm during install

valuesFrom object[]

An array of of configmap or secrets references defined in the downstream clusters to get values for the chart.

version string

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. The version also determines which chart to download from OCI registries

waitForJobs boolean

Wait for all jobs to complete before marking the GitRepo as ready. A timeoutSeconds duration must be set when using. Default: true

kustomize object | null
dir string

Custom folder for kustomize resources. This folder must contain a kustomization.yaml file. Path is relative to repository root