Custom Resources Spec

metadata

metav1.ObjectMeta

false

spec

BundleSpec

true

status

BundleStatus

true

readyClusters

ReadyClusters is a string in the form "%d/%d", that describes the number of clusters that are ready vs. the number of clusters desired to be ready.

string

false

state

State is a summary state for the bundle, calculated over the non-ready resources.

string

false

metadata

metav1.ListMeta

false

items

[]Bundle

true

name

Name of the bundle.

string

false

selector

Selector matching bundle’s labels.

*metav1.LabelSelector

false

name

Name of the resource, can include the bundle’s internal path.

string

false

content

The content of the resource, can be compressed.

string

false

encoding

Encoding is either empty or "base64+gz".

string

false

paused

Paused if set to true, will stop any BundleDeployments from being updated. It will be marked as out of sync.

bool

false

rolloutStrategy

RolloutStrategy controls the rollout of bundles, by defining partitions, canaries and percentages for cluster availability.

*RolloutStrategy

false

resources

Resources contains the resources that were read from the bundle’s path. This includes the content of downloaded helm charts.

[]BundleResource

false

targets

Targets refer to the clusters which will be deployed to. Targets are evaluated in order and the first one to match is used.

[]BundleTarget

false

targetRestrictions

TargetRestrictions is an allow list, which controls if a bundledeployment is created for a target.

[]BundleTargetRestriction

false

dependsOn

DependsOn refers to the bundles which must be ready before this bundle can be deployed.

[]BundleRef

false

contentsId

ContentsID stores the contents id when deploying contents using an OCI registry.

string

false

conditions

Conditions is a list of Wrangler conditions that describe the state of the bundle.

[]genericcondition.GenericCondition

false

summary

Summary contains the number of bundle deployments in each state and a list of non-ready resources.

BundleSummary

false

newlyCreated

NewlyCreated is the number of bundle deployments that have been created, not updated.

int

false

unavailable

Unavailable is the number of bundle deployments that are not ready or where the AppliedDeploymentID in the status does not match the DeploymentID from the spec.

int

true

unavailablePartitions

UnavailablePartitions is the number of unavailable partitions.

int

true

maxUnavailable

MaxUnavailable is the maximum number of unavailable deployments. See rollout configuration.

int

true

maxUnavailablePartitions

MaxUnavailablePartitions is the maximum number of unavailable partitions. The rollout configuration defines a maximum number or percentage of unavailable partitions.

int

true

maxNew

MaxNew is always 50. A bundle change can only stage 50 bundledeployments at a time.

int

false

partitions

PartitionStatus lists the status of each partition.

[]PartitionStatus

false

display

Display contains the number of ready, desiredready clusters and a summary state for the bundle’s resources.

BundleDisplay

false

resourceKey

ResourceKey lists resources, which will likely be deployed. The actual list of resources on a cluster might differ, depending on the helm chart, value templating, etc..

[]ResourceKey

false

ociReference

OCIReference is the OCI reference used to store contents, this is only for informational purposes.

string

false

observedGeneration

ObservedGeneration is the current generation of the bundle.

int64

true

resourcesSha256Sum

ResourcesSHA256Sum corresponds to the JSON serialization of the .Spec.Resources field

string

false

notReady

NotReady is the number of bundle deployments that have been deployed where some resources are not ready.

int

false

waitApplied

WaitApplied is the number of bundle deployments that have been synced from SUSE® Rancher Prime Continuous Delivery controller and downstream cluster, but are waiting to be deployed.

int

false

errApplied

ErrApplied is the number of bundle deployments that have been synced from the SUSE® Rancher Prime Continuous Delivery controller and the downstream cluster, but with some errors when deploying the bundle.

int

false

outOfSync

OutOfSync is the number of bundle deployments that have been synced from SUSE® Rancher Prime Continuous Delivery controller, but not yet by the downstream agent.

int

false

modified

Modified is the number of bundle deployments that have been deployed and for which all resources are ready, but where some changes from the Git repository have not yet been synced.

int

false

ready

Ready is the number of bundle deployments that have been deployed where all resources are ready.

int

true

pending

Pending is the number of bundle deployments that are being processed by SUSE® Rancher Prime Continuous Delivery controller.

int

false

desiredReady

DesiredReady is the number of bundle deployments that should be ready.

int

true

nonReadyResources

NonReadyClusters is a list of states, which is filled for a bundle that is not ready.

[]NonReadyResource

false

name

Name of target. This value is largely for display and logging. If not specified a default name of the format "target000" will be used

string

false

clusterName

ClusterName to match a specific cluster by name that will be selected

string

false

clusterSelector

ClusterSelector is a selector to match clusters. The structure is the standard metav1.LabelSelector format. If clusterGroupSelector or clusterGroup is specified, clusterSelector will be used only to further refine the selection after clusterGroupSelector and clusterGroup is evaluated.

*metav1.LabelSelector

false

clusterGroup

ClusterGroup to match a specific cluster group by name.

string

false

clusterGroupSelector

ClusterGroupSelector is a selector to match cluster groups.

*metav1.LabelSelector

false

doNotDeploy

DoNotDeploy if set to true, will not deploy to this target.

bool

false

namespaceLabels

NamespaceLabels are labels that will be appended to the namespace created by Fleet.

map[string]string

false

namespaceAnnotations

NamespaceAnnotations are annotations that will be appended to the namespace created by Fleet.

map[string]string

false

name

string

false

clusterName

string

false

clusterSelector

*metav1.LabelSelector

false

clusterGroup

string

false

clusterGroupSelector

*metav1.LabelSelector

false

name

Name is the name of the resource.

string

false

bundleState

State is the state of the resource, like e.g. "NotReady" or "ErrApplied".

BundleState

false

message

Message contains information why the bundle is not ready.

string

false

modifiedStatus

ModifiedStatus lists the state for each modified resource.

[]ModifiedStatus

false

nonReadyStatus

NonReadyStatus lists the state for each non-ready resource.

[]NonReadyStatus

false

name

A user-friendly name given to the partition used for Display (optional).

string

false

maxUnavailable

A number or percentage of clusters that can be unavailable in this partition before this partition is treated as done. default: 10%

*intstr.IntOrString

false

clusterName

ClusterName is the name of a cluster to include in this partition

string

false

clusterSelector

Selector matching cluster labels to include in this partition

*metav1.LabelSelector

false

clusterGroup

A cluster group name to include in this partition

string

false

clusterGroupSelector

Selector matching cluster group labels to include in this partition

*metav1.LabelSelector

false

name

Name is the name of the partition.

string

false

count

Count is the number of clusters in the partition.

int

false

maxUnavailable

MaxUnavailable is the maximum number of unavailable clusters in the partition.

int

false

unavailable

Unavailable is the number of unavailable clusters in the partition.

int

false

summary

Summary is a summary state for the partition, calculated over its non-ready resources.

BundleSummary

false

kind

Kind is the k8s api kind of the resource.

string

false

apiVersion

APIVersion is the k8s api version of the resource.

string

false

namespace

Namespace is the namespace of the resource.

string

false

name

Name is the name of the resource.

string

false

maxUnavailable

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%

*intstr.IntOrString

false

maxUnavailablePartitions

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

*intstr.IntOrString

false

autoPartitionSize

A number or percentage of how to automatically partition clusters if no specific partitioning strategy is configured. default: 25%

*intstr.IntOrString

false

partitions

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

[]Partition

false

metadata

metav1.ObjectMeta

false

spec

BundleDeploymentSpec

false

status

BundleDeploymentStatus

false

deployed

string

false

monitored

string

false

state

string

false

metadata

metav1.ListMeta

false

items

[]BundleDeployment

true

defaultNamespace

DefaultNamespace is the namespace to use for resources that do not specify a namespace. This field is not used to enforce or lock down the deployment to a specific namespace.

string

false

namespace

TargetNamespace if present will assign all resource to this namespace and if any cluster scoped resource exists the deployment will fail.

string

false

kustomize

Kustomize options for the deployment, like the dir containing the kustomization.yaml file.

*KustomizeOptions

false

helm

Helm options for the deployment, like the chart name, repo and values.

*HelmOptions

false

serviceAccount

ServiceAccount which will be used to perform this deployment.

string

false

forceSyncGeneration

ForceSyncGeneration is used to force a redeployment

int64

false

yaml

YAML options, if using raw YAML these are names that map to overlays/{name} files that will be used to replace or patch a resource.

*YAMLOptions

false

diff

Diff can be used to ignore the modified state of objects which are amended at runtime.

*DiffOptions

false

keepResources

KeepResources can be used to keep the deployed resources when removing the bundle

bool

false

deleteNamespace

DeleteNamespace can be used to delete the deployed namespace when removing the bundle

bool

false

ignore

IgnoreOptions can be used to ignore fields when monitoring the bundle.

IgnoreOptions

false

correctDrift

CorrectDrift specifies how drift correction should work.

*CorrectDrift

false

namespaceLabels

NamespaceLabels are labels that will be appended to the namespace created by Fleet.

map[string]string

false

namespaceAnnotations

NamespaceAnnotations are annotations that will be appended to the namespace created by Fleet.

map[string]string

false

deleteCRDResources

DeleteCRDResources deletes CRDs. Warning! this will also delete all your Custom Resources.

bool

false

kind

string

false

apiVersion

string

false

namespace

string

false

name

string

false

createdAt

metav1.Time

false

paused

Paused if set to true, will stop any BundleDeployments from being updated. If true, BundleDeployments will be marked as out of sync when changes are detected.

bool

false

stagedOptions

StagedOptions are the deployment options, that are staged for the next deployment.

BundleDeploymentOptions

false

stagedDeploymentID

StagedDeploymentID is the ID of the staged deployment.

string

false

options

Options are the deployment options, that are currently applied.

BundleDeploymentOptions

false

deploymentID

DeploymentID is the ID of the currently applied deployment.

string

false

dependsOn

DependsOn refers to the bundles which must be ready before this bundle can be deployed.

[]BundleRef

false

correctDrift

CorrectDrift specifies how drift correction should work.

*CorrectDrift

false

ociContents

OCIContents is true when this deployment’s contents is stored in an oci registry

bool

false

conditions

[]genericcondition.GenericCondition

false

appliedDeploymentID

string

false

release

Release is the Helm release ID

string

false

ready

bool

false

nonModified

bool

false

nonReadyStatus

[]NonReadyStatus

false

modifiedStatus

[]ModifiedStatus

false

display

BundleDeploymentDisplay

false

syncGeneration

*int64

false

resources

Resources lists the metadata of resources that were deployed according to the helm release history.

[]BundleDeploymentResource

false

kind

Kind is the kind of the resource to match.

string

false

apiVersion

APIVersion is the apiVersion of the resource to match.

string

false

namespace

Namespace is the namespace of the resource to match.

string

false

name

Name is the name of the resource to match.

string

false

operations

Operations remove a JSON path from the resource.

[]Operation

false

jsonPointers

JSONPointers ignore diffs at a certain JSON path.

[]string

false

namespace

string

false

key

string

false

comparePatches

ComparePatches match a resource and remove fields from the check for modifications.

[]ComparePatch

false

chart

Chart can refer to any go-getter URL or OCI registry based helm chart URL. The chart will be downloaded.

string

false

repo

Repo is the name of the HTTPS helm repo to download the chart from.

string

false

releaseName

ReleaseName sets 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.

string

false

version

Version of the chart to download

string

false

timeoutSeconds

TimeoutSeconds is the time to wait for Helm operations.

int

false

values

Values passed to Helm. It is possible to specify the keys and values as go template strings.

*GenericMap

false

valuesFrom

ValuesFrom loads the values from configmaps and secrets.

[]ValuesFrom

false

force

Force allows to override immutable resources. This could be dangerous.

bool

false

takeOwnership

TakeOwnership makes helm skip the check for its own annotations

bool

false

maxHistory

MaxHistory limits the maximum number of revisions saved per release by Helm.

int

false

valuesFiles

ValuesFiles is a list of files to load values from.

[]string

false

waitForJobs

WaitForJobs if set and timeoutSeconds provided, will wait until all Jobs have been completed before marking the GitRepo as ready. It will wait for as long as timeoutSeconds

bool

false

atomic

Atomic sets the --atomic flag when Helm is performing an upgrade

bool

false

disablePreProcess

DisablePreProcess disables template processing in values

bool

false

disableDNS

DisableDNS can be used to customize Helm’s EnableDNS option, which SUSE® Rancher Prime Continuous Delivery sets to true by default.

bool

false

skipSchemaValidation

SkipSchemaValidation allows skipping schema validation against the chart values

bool

false

disableDependencyUpdate

DisableDependencyUpdate allows skipping chart dependencies update

bool

false

conditions

Conditions is a list of conditions to be ignored when monitoring the Bundle.

[]map[string]string

false

dir

Dir points to a custom folder for kustomize resources. This folder must contain a kustomization.yaml file.

string

false

name

Name of a resource in the same namespace as the referent.

string

true

kind

string

false

apiVersion

string

false

namespace

string

false

name

string

false

missing

bool

false

exist

Exist is true if the resource exists but is not owned by us. This can happen if a resource was adopted by another bundle whereas the first bundle still exists and due to that reports that it does not own it.

bool

false

delete

bool

false

patch

string

false

uid

types.UID

false

kind

string

false

apiVersion

string

false

namespace

string

false

name

string

false

summary

summary.Summary

false

op

Op is usually "remove"

string

false

path

Path is the JSON path to remove.

string

false

value

Value is usually empty.

string

false

namespace

string

false

key

string

false

configMapKeyRef

The reference to a config map with release values.

*ConfigMapKeySelector

false

secretKeyRef

The reference to a secret with release values.

*SecretKeySelector

false

overlays

Overlays is a list of names that maps to folders in "overlays/". If you wish to customize the file ./subdir/resource.yaml then a file ./overlays/myoverlay/subdir/resource.yaml will replace the base file. A file named ./overlays/myoverlay/subdir/resource_patch.yaml will patch the base file.

[]string

false

metadata

metav1.ObjectMeta

false

bundleSelector

*metav1.LabelSelector

false

namespaceSelector

*metav1.LabelSelector

false

metadata

metav1.ListMeta

false

items

[]BundleNamespaceMapping

true

lastSeen

LastSeen is the last time the agent checked in to update the status of the cluster resource.

metav1.Time

true

namespace

Namespace is the namespace of the agent deployment, e.g. "cattle-fleet-system".

string

true

metadata

metav1.ObjectMeta

false

spec

ClusterSpec

false

status

ClusterStatus

false

readyBundles

ReadyBundles is a string in the form "%d/%d", that describes the number of bundles that are ready vs. the number of bundles desired to be ready.

string

false

state

State of the cluster, either one of the bundle states, or "WaitCheckIn".

string

false

metadata

metav1.ListMeta

false

items

[]Cluster

true

paused

Paused if set to true, will stop any BundleDeployments from being updated.

bool

false

clientID

ClientID is a unique string that will identify the cluster. It can either be predefined, or generated when importing the cluster.

string

false

kubeConfigSecret

KubeConfigSecret is the name of the secret containing the kubeconfig for the downstream cluster. It can optionally contain a APIServerURL and CA to override the values in the fleet-controller’s configmap.

string

false

kubeConfigSecretNamespace

KubeConfigSecretNamespace is the namespace of the secret containing the kubeconfig for the downstream cluster. If unset, it will be assumed the secret can be found in the namespace that the Cluster object resides within.

string

false

redeployAgentGeneration

RedeployAgentGeneration can be used to force redeploying the agent.

int64

false

agentEnvVars

AgentEnvVars are extra environment variables to be added to the agent deployment.

[]corev1.EnvVar

false

agentNamespace

AgentNamespace defaults to the system namespace, e.g. cattle-fleet-system.

string

false

privateRepoURL

PrivateRepoURL prefixes the image name and overrides a global repo URL from the agents config.

string

false

templateValues

TemplateValues defines a cluster specific mapping of values to be sent to fleet.yaml values templating.

*GenericMap

false

agentTolerations

AgentTolerations defines an extra set of Tolerations to be added to the Agent deployment.

[]corev1.Toleration

false

agentAffinity

AgentAffinity overrides the default affinity for the cluster’s agent deployment. If this value is nil the default affinity is used.

*corev1.Affinity

false

agentResources

AgentResources sets the resources for the cluster’s agent deployment.

*corev1.ResourceRequirements

false

hostNetwork

HostNetwork sets the agent StatefulSet to use hostNetwork: true setting. Allows for provisioning of network related bundles (CNI configuration).

*bool

false

conditions

[]genericcondition.GenericCondition

false

namespace

Namespace is the cluster namespace, it contains the clusters service account as well as any bundledeployments. Example: "cluster-fleet-local-cluster-294db1acfa77-d9ccf852678f"

string

false

summary

Summary is a summary of the bundledeployments. The resource counts are copied from the gitrepo resource.

BundleSummary

false

resourceCounts

ResourceCounts is an aggregate over the GitRepoResourceCounts.

GitRepoResourceCounts

false

readyGitRepos

ReadyGitRepos is the number of gitrepos for this cluster that are ready.

int

true

desiredReadyGitRepos

DesiredReadyGitRepos is the number of gitrepos for this cluster that are desired to be ready.

int

true

agentEnvVarsHash

AgentEnvVarsHash is a hash of the agent’s env vars, used to detect changes.

string

false

agentPrivateRepoURL

AgentPrivateRepoURL is the private repo URL for the agent that is currently used.

string

false

agentHostNetwork

AgentHostNetwork defines observed state of spec.hostNetwork setting that is currently used.

bool

false

agentDeployedGeneration

AgentDeployedGeneration is the generation of the agent that is currently deployed.

*int64

false

agentMigrated

AgentMigrated is always set to true after importing a cluster. If false, it will trigger a migration. Old agents don’t have this in their status.

bool

false

agentNamespaceMigrated

AgentNamespaceMigrated is always set to true after importing a cluster. If false, it will trigger a migration. Old SUSE® Rancher Prime Continuous Delivery agents don’t have this in their status.

bool

false

cattleNamespaceMigrated

CattleNamespaceMigrated is always set to true after importing a cluster. If false, it will trigger a migration. Old SUSE® Rancher Prime Continuous Delivery agents, don’t have this in their status.

bool

false

agentAffinityHash

AgentAffinityHash is a hash of the agent’s affinity configuration, used to detect changes.

string

false

agentResourcesHash

AgentResourcesHash is a hash of the agent’s resources configuration, used to detect changes.

string

false

agentTolerationsHash

AgentTolerationsHash is a hash of the agent’s tolerations configuration, used to detect changes.

string

false

agentConfigChanged

AgentConfigChanged is set to true if any of the agent configuration changed, like the API server URL or CA. Setting it to true will trigger a re-import of the cluster.

bool

false

apiServerURL

APIServerURL is the currently used URL of the API server that the cluster uses to connect to upstream.

string

false

apiServerCAHash

APIServerCAHash is a hash of the upstream API server CA, used to detect changes.

string

false

agentTLSMode

AgentTLSMode supports two values: system-store and strict. If set to system-store, instructs the agent to trust CA bundles from the operating system’s store. If set to strict, then the agent shall only connect to a server which uses the exact CA configured when creating/updating the agent.

string

false

display

Display contains the number of ready bundles, nodes and a summary state.

ClusterDisplay

false

agent

AgentStatus contains information about the agent.

AgentStatus

false

garbageCollectionInterval

GarbageCollectionInterval determines how often agents clean up obsolete Helm releases.

*metav1.Duration

false

metadata

metav1.ObjectMeta

false

spec

ClusterGroupSpec

true

status

ClusterGroupStatus

true

readyClusters

ReadyClusters is a string in the form "%d/%d", that describes the number of clusters that are ready vs. the number of clusters desired to be ready.

string

false

readyBundles

ReadyBundles is a string in the form "%d/%d", that describes the number of bundles that are ready vs. the number of bundles desired to be ready.

string

false

state

State is a summary state for the cluster group, showing "NotReady" if there are non-ready resources.

string

false

metadata

metav1.ListMeta

false

items

[]ClusterGroup

true

selector

Selector is a label selector, used to select clusters for this group.

*metav1.LabelSelector

false

clusterCount

ClusterCount is the number of clusters in the cluster group.

int

true

nonReadyClusterCount

NonReadyClusterCount is the number of clusters that are not ready.

int

true

nonReadyClusters

NonReadyClusters is a list of cluster names that are not ready.

[]string

false

conditions

Conditions is a list of conditions and their statuses for the cluster group.

[]genericcondition.GenericCondition

false

summary

Summary is a summary of the bundle deployments and their resources in the cluster group.

BundleSummary

false

display

Display contains the number of ready, desiredready clusters and a summary state for the bundle’s resources.

ClusterGroupDisplay

false

resourceCounts

ResourceCounts contains the number of resources in each state over all bundles in the cluster group.

GitRepoResourceCounts

false

metadata

metav1.ObjectMeta

false

spec

ClusterRegistrationSpec

false

status

ClusterRegistrationStatus

false

metadata

metav1.ListMeta

false

items

[]ClusterRegistration

true

clientID

ClientID is a unique string that will identify the cluster. The agent either uses the configured ID or the kubeSystem.UID.

string

false

clientRandom

ClientRandom is a random string that the agent generates. When fleet-controller grants a registration, it creates a registration secret with this string in the name.

string

false

clusterLabels

ClusterLabels are copied to the cluster resource during the registration.

map[string]string

false

clusterName

ClusterName is only set after the registration is being processed by fleet-controller.

string

false

granted

Granted is set to true, if the request service account is present and its token secret exists. This happens directly before creating the registration secret, roles and rolebindings.

bool

false

metadata

metav1.ObjectMeta

false

spec

ClusterRegistrationTokenSpec

false

status

ClusterRegistrationTokenStatus

false

metadata

metav1.ListMeta

false

items

[]ClusterRegistrationToken

true

ttl

TTL is the time to live for the token. It is used to calculate the expiration time. If the token expires, it will be deleted.

*metav1.Duration

false

expires

Expires is the time when the token expires.

*metav1.Time

false

secretName

SecretName is the name of the secret containing the token.

string

false

metadata

metav1.ObjectMeta

false

content

Content is a byte array, which contains the manifests of a bundle. The bundle resources are copied into the bundledeployment’s content resource, so the downstream agent can deploy them.

[]byte

false

sha256sum

SHA256Sum of the Content field

string

false

metadata

metav1.ListMeta

false

items

[]Content

true

authorName

AuthorName gives the name to provide when making a commit

string

true

authorEmail

AuthorEmail gives the email to provide when making a commit

string

true

messageTemplate

MessageTemplate provides a template for the commit message, into which will be interpolated the details of the change made.

string

false

enabled

Enabled correct drift if true.

bool

false

force

Force helm rollback with --force option will be used if true. This will try to recreate all resources in the release.

bool

false

keepFailHistory

KeepFailHistory keeps track of failed rollbacks in the helm history.

bool

false

metadata

metav1.ObjectMeta

false

spec

GitRepoSpec

false

status

GitRepoStatus

false

readyBundleDeployments

ReadyBundleDeployments is a string in the form "%d/%d", that describes the number of ready bundledeployments over the total number of bundledeployments.

string

false

state

State is the state of the GitRepo, e.g. "GitUpdating" or the maximal BundleState according to StateRank.

string

false

message

Message contains the relevant message from the deployment conditions.

string

false

error

Error is true if a message is present.

bool

false

metadata

metav1.ListMeta

false

items

[]GitRepo

true

apiVersion

APIVersion is the API version of the resource.

string

false

kind

Kind is the k8s kind of the resource.

string

false

type

Type is the type of the resource, e.g. "apiextensions.k8s.io.customresourcedefinition" or "configmap".

string

false

id

ID is the name of the resource, e.g. "namespace1/my-config" or "backingimagemanagers.storage.io".

string

false

namespace

Namespace of the resource.

string

false

name

Name of the resource.

string

false

incompleteState

IncompleteState is true if a bundle summary has 10 or more non-ready resources or a non-ready resource has more 10 or more non-ready or modified states.

bool

false

state

State is the state of the resource, e.g. "Unknown", "WaitApplied", "ErrApplied" or "Ready".

string

false

error

Error is true if any Error in the PerClusterState is true.

bool

false

transitioning

Transitioning is true if any Transitioning in the PerClusterState is true.

bool

false

message

Message is the first message from the PerClusterStates.

string

false

perClusterState

PerClusterState is a list of states for each cluster. Derived from the summaries non-ready resources.

[]ResourcePerClusterState

false

ready

Ready is the number of ready resources.

int

true

desiredReady

DesiredReady is the number of resources that should be ready.

int

true

waitApplied

WaitApplied is the number of resources that are waiting to be applied.

int

true

modified

Modified is the number of resources that have been modified.

int

true

orphaned

Orphaned is the number of orphaned resources.

int

true

missing

Missing is the number of missing resources.

int

true

unknown

Unknown is the number of resources in an unknown state.

int

true

notReady

NotReady is the number of not ready resources. Resources are not ready if they do not match any other state.

int

true

repo

Repo is a URL to a git repo to clone and index.

string

false

branch

Branch The git branch to follow.

string

false

revision

Revision A specific commit or tag to operate on.

string

false

targetNamespace

Ensure that all resources are created in this namespace Any cluster scoped resource will be rejected if this is set Additionally this namespace will be created on demand.

string

false

clientSecretName

ClientSecretName is the name of the client secret to be used to connect to the repo It is expected the secret be of type "kubernetes.io/basic-auth" or "kubernetes.io/ssh-auth".

string

false

helmSecretName

HelmSecretName contains the auth secret for a private Helm repository.

string

false

helmSecretNameForPaths

HelmSecretNameForPaths contains the auth secret for private Helm repository for each path.

string

false

helmRepoURLRegex

HelmRepoURLRegex Helm credentials will be used if the helm repo matches this regex Credentials will always be used if this is empty or not provided.

string

false

caBundle

CABundle is a PEM encoded CA bundle which will be used to validate the repo’s certificate.

[]byte

false

insecureSkipTLSVerify

InsecureSkipTLSverify will use insecure HTTPS to clone the repo.

bool

false

paths

Paths is the directories relative to the git repo root that contain resources to be applied. Path globbing is supported, for example ["charts/*"] will match all folders as a subdirectory of charts/ If empty, "/" is the default.

[]string

false

paused

Paused, when true, causes changes in Git not to be propagated down to the clusters but instead to mark resources as OutOfSync.

bool

false

serviceAccount

ServiceAccount used in the downstream cluster for deployment.

string

false

targets

Targets is a list of targets this repo will deploy to.

[]GitTarget

false

pollingInterval

PollingInterval is how often to check git for new updates.

*metav1.Duration

false

forceSyncGeneration

Increment this number to force a redeployment of contents from Git.

int64

false

imageScanInterval

ImageScanInterval is the interval of syncing scanned images and writing back to git repo.

*metav1.Duration

false

imageScanCommit

Commit specifies how to commit to the git repo when a new image is scanned and written back to git repo.

CommitSpec

false

keepResources

KeepResources specifies if the resources created must be kept after deleting the GitRepo.

bool

false

deleteNamespace

DeleteNamespace specifies if the namespace created must be deleted after deleting the GitRepo.

bool

false

correctDrift

CorrectDrift specifies how drift correction should work.

*CorrectDrift

false

disablePolling

Disables git polling. When enabled only webhooks will be used.

bool

false

ociRegistry

OCIRegistry specifies the OCI registry related parameters

*[OCIRegistrySpec](#ociregistryspec)

false

observedGeneration

ObservedGeneration is the current generation of the resource in the cluster. It is copied from k8s metadata.Generation. The value is incremented for all changes, except for changes to .metadata or .status.

int64

true

updateGeneration

Update generation is the force update generation if spec.forceSyncGeneration is set

int64

false

commit

Commit is the Git commit hash from the last git job run.

string

false

webhookCommit

WebhookCommit is the latest Git commit hash received from a webhook

string

false

readyClusters

ReadyClusters is the lowest number of clusters that are ready over all the bundles of this GitRepo.

int

true

desiredReadyClusters

DesiredReadyClusters\tis the number of clusters that should be ready for bundles of this GitRepo.

int

true

gitJobStatus

GitJobStatus is the status of the last Git job run, e.g. "Current" if there was no error.

string

false

summary

Summary contains the number of bundle deployments in each state and a list of non-ready resources.

BundleSummary

false

display

Display contains a human readable summary of the status.

GitRepoDisplay

false

conditions

Conditions is a list of Wrangler conditions that describe the state of the GitRepo.

[]genericcondition.GenericCondition

false

resources

Resources contains metadata about the resources of each bundle.

[]GitRepoResource

false

resourceCounts

ResourceCounts contains the number of resources in each state over all bundles.

GitRepoResourceCounts

false

resourceErrors

ResourceErrors is a sorted list of errors from the resources.

[]string

false

lastSyncedImageScanTime

LastSyncedImageScanTime is the time of the last image scan.

metav1.Time

false

lastPollingTriggered

LastPollingTime is the last time the polling check was triggered

metav1.Time

false

name

Name is the name of this target.

string

false

clusterName

ClusterName is the name of a cluster.

string

false

clusterSelector

ClusterSelector is a label selector to select clusters.

*metav1.LabelSelector

false

clusterGroup

ClusterGroup is the name of a cluster group in the same namespace as the clusters.

string

false

clusterGroupSelector

ClusterGroupSelector is a label selector to select cluster groups.

*metav1.LabelSelector

false

reference

Reference of the OCI Registry

string

false

authSecretName

AuthSecretName contains the auth secret where the OCI regristry credentials are stored.

string

false

basicHTTP

BasicHTTP uses HTTP connections to the OCI registry when enabled.

bool

false

insecureSkipTLS

InsecureSkipTLS allows connections to OCI registry without certs when enabled.

bool

false

state

State is the state of the resource.

string

false

error

Error is true if the resource is in an error state, copied from the bundle’s summary for non-ready resources.

bool

false

transitioning

Transitioning is true if the resource is in a transitioning state, copied from the bundle’s summary for non-ready resources.

bool

false

message

Message combines the messages from the bundle’s summary. Messages are joined with the delimiter ';'.

string

false

patch

Patch for modified resources.

*GenericMap

false

clusterId

ClusterID is the id of the cluster.

string

false

metadata

metav1.ObjectMeta

false

defaultServiceAccount

DefaultServiceAccount overrides the GitRepo’s default service account.

string

false

allowedServiceAccounts

AllowedServiceAccounts is a list of service accounts that GitRepos are allowed to use.

[]string

false

allowedRepoPatterns

AllowedRepoPatterns is a list of regex patterns that restrict the valid values of the Repo field of a GitRepo.

[]string

false

defaultClientSecretName

DefaultClientSecretName overrides the GitRepo’s default client secret.

string

false

allowedClientSecretNames

AllowedClientSecretNames is a list of client secret names that GitRepos are allowed to use.

[]string

false

allowedTargetNamespaces

AllowedTargetNamespaces restricts TargetNamespace to the given namespaces. If AllowedTargetNamespaces is set, TargetNamespace must be set.

[]string

false

metadata

metav1.ListMeta

false

items

[]GitRepoRestriction

true

order

Order specifies the sorting order of the tags. Given the letters of the alphabet as tags, ascending order would select Z, and descending order would select A.

string

false

semver

SemVer gives a semantic version range to check against the tags available.

*SemVerPolicy

false

alphabetical

Alphabetical set of rules to use for alphabetical ordering of the tags.

*AlphabeticalPolicy

false

metadata

metav1.ObjectMeta

false

spec

ImageScanSpec

false

status

ImageScanStatus

false

metadata

metav1.ListMeta

false

items

[]ImageScan

true

tagName

TagName is the tag ref that needs to be put in manifest to replace fields

string

false

gitrepoName

GitRepo reference name

string

false

image

Image is the name of the image repository

string

false

interval

Interval is the length of time to wait between scans of the image repository.

metav1.Duration

false

secretRef

SecretRef can be given the name of a secret containing credentials to use for the image registry. The secret should be created with kubectl create secret docker-registry, or the equivalent.

*corev1.LocalObjectReference

false

suspend

This flag tells the controller to suspend subsequent image scans. It does not apply to already started scans. Defaults to false.

bool

false

policy

Policy gives the particulars of the policy to be followed in selecting the most recent image

ImagePolicyChoice

true

conditions

[]genericcondition.GenericCondition

false

lastScanTime

LastScanTime is the last time image was scanned

metav1.Time

false

latestImage

LatestImage gives the first in the list of images scanned by the image repository, when filtered and ordered according to the policy.

string

false

latestTag

Latest tag is the latest tag filtered by the policy

string

false

latestDigest

LatestDigest is the digest of latest tag

string

false

observedGeneration

int64

false

canonicalImageName

CanonicalName is the name of the image repository with all the implied bits made explicit; e.g., docker.io/library/alpine rather than alpine.

string

false

range

Range gives a semver range for the image tag; the highest version within the range that’s a tag yields the latest image.

string

true

name

Name of the bundle which will be created.

string

false

labels

Labels are copied to the bundle and can be used in a dependsOn.selector.

map[string]string

false

BundleSpec

BundleSpec

false

targetCustomizations

TargetCustomizations 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.

[]BundleTarget

false

imageScans

ImageScans are optional and used to update container image references in the git repo.

[]ImageScanYAML

false

overrideTargets

OverrideTargets overrides targets that are defined in the GitRepo resource. If overrideTargets is provided the bundle will not inherit targets from the GitRepo.

[]GitTarget

false

name

Name of the image scan. Unused.

string

false

ImageScanSpec

ImageScanSpec

false