Fleet CRD Schema Summary

This table summarizes the Custom Resource Definitions (CRDs) used in Fleet, including their purpose and top-level schema properties. Each CRD defines how Fleet manages applications, deployments, and cluster configurations.

CRD Description Top-level Properties Reference

Bundle v1alpha1

Bundle contains the resources of an application and its deployment options. It is deployed as a Helm chart to target clusters. When a GitRepo is scanned, it produces one or more bundles. Bundles are collections of resources deployed to one or more clusters and represent the fundamental deployment unit used in Fleet. The contents of a Bundle may include Kubernetes manifests, Kustomize configuration, or Helm charts. Regardless of the source, the contents are dynamically rendered into a Helm chart by the agent and installed into the downstream cluster as a Helm release.

apiVersion, kind, metadata, spec, status

Bundle v1alpha1

BundleDeployment v1alpha1

BundleDeployment is used internally by Fleet and should not be used directly. When a Bundle is deployed to a cluster, an instance of a Bundle is called a BundleDeployment. It represents the state of that Bundle on a specific cluster with cluster-specific customizations. The Fleet agent is aware only of BundleDeployment resources created for the cluster it manages.

apiVersion, kind, metadata, spec, status

BundleDeployment v1alpha1

BundleNamespaceMapping v1alpha1

BundleNamespaceMapping maps bundles to clusters in other namespaces.

apiVersion, bundleSelector, kind, metadata, namespaceSelector

BundleNamespaceMapping v1alpha1

Cluster v1alpha1

Cluster corresponds to a Kubernetes cluster. Fleet deploys bundles to targeted clusters, referred to as downstream clusters. In a single-cluster deployment, the Fleet cluster acts as both manager and downstream cluster.

apiVersion, kind, metadata, spec, status

Cluster v1alpha1

ClusterGroup v1alpha1

ClusterGroup is a reusable selector used to target a group of clusters.

apiVersion, kind, metadata, spec, status

ClusterGroup v1alpha1

ClusterRegistration v1alpha1

ClusterRegistration is used internally by Fleet and should not be used directly.

apiVersion, kind, metadata, spec, status

ClusterRegistration v1alpha1

ClusterRegistrationToken v1alpha1

ClusterRegistrationToken is used by agents to register a new cluster.

apiVersion, kind, metadata, spec, status

ClusterRegistrationToken v1alpha1

Content v1alpha1

Content is used internally by Fleet and should not be used directly. It contains the resources from a bundle for a specific target cluster.

apiVersion, content, kind, metadata, sha256sum

Content v1alpha1

GitRepo v1alpha1

GitRepo describes a Git repository watched by Fleet. The resource contains the necessary information to deploy the repository, or parts of it, to target clusters.

apiVersion, kind, metadata, spec, status

GitRepo v1alpha1

GitRepoRestriction v1alpha1

GitRepoRestriction optionally restricts GitRepo options within the same namespace.

allowedClientSecretNames, allowedRepoPatterns, allowedServiceAccounts, allowedTargetNamespaces, apiVersion, defaultClientSecretName, defaultServiceAccount, kind, metadata

GitRepoRestriction v1alpha1

HelmOp v1alpha1

HelmOp describes Helm chart information required to deploy a chart to target clusters.

apiVersion, kind, metadata, spec, status

HelmOp v1alpha1

ImageScan v1alpha1

JSON schema for ImageScan (v1alpha1) in group fleet.cattle.io.

apiVersion, kind, metadata, spec, status

ImageScan v1alpha1

Schedule v1alpha1

Schedule represents a deployment schedule that determines when deployments are allowed or restricted.

apiVersion, kind, metadata, spec, status

Schedule v1alpha1

For more information, refer to fleet-crds.yaml.