Application API reference

Fleet defines the fleet to dispatch the artifact.

ClusterSelector specifies the selectors to select the clusters within the fleet. If unspecified, all clusters in the fleet will be selected.

Source defines the artifact source.

SyncPolicies controls how the artifact will be customized and where it will be synced.

Destination defines the destination clusters where the artifacts will be synced. It can be overriden by the syncPolicies’ destination.

Name defines the name of the sync policy. If unspecified, a name of format <application name>-<index> will be generated.

Kustomization defines the configuration to calculate the desired state from a source using kustomize.

HelmRelease defines the desired state of a Helm release.

Destination defines the destination for the artifact. If specified, it will override the destination specified at Application level.

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”. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

Annotations to be added to the object’s metadata.

Labels to be added to the object’s metadata.

ObjectMeta holds the template for metadata like labels and annotations.

Spec holds the template for the v1beta2.HelmChartSpec for this HelmRelease.

Map of string keys and values that can be used to organize and categorize (scope and select) objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

The name or path the Helm chart is available at in the SourceRef.

Version semver expression, ignored for charts from v1beta2.GitRepository and v1beta2.Bucket sources. Defaults to latest when omitted.

Interval at which to check the v1beta2.Source for updates. Defaults to ‘HelmReleaseSpec.Interval’.

Determines what enables the creation of a new artifact. Valid values are (‘ChartVersion’, ‘Revision’). See the documentation of the values for an explanation on their behavior. Defaults to ChartVersion when omitted.

Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted.

Chart defines the template of the v1beta2.HelmChart that should be created for this HelmRelease.

Interval at which to reconcile the Helm release.

Suspend tells the controller to suspend reconciliation for this HelmRelease, it does not apply to already started reconciliations. Defaults to false.

ReleaseName used for the Helm release. Defaults to a composition of ‘[TargetNamespace-]Name’.

TargetNamespace to target when performing operations for the HelmRelease. Defaults to the namespace of the HelmRelease.

DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled.

Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm action. Defaults to ‘5m0s’.

MaxHistory is the number of revisions saved by Helm for this HelmRelease. Use ‘0’ for an unlimited number of revisions; defaults to ‘10’.

The name of the Kubernetes service account to impersonate when reconciling this HelmRelease.

PersistentClient tells the controller to use a persistent Kubernetes client for this release. When enabled, the client will be reused for the duration of the reconciliation, instead of being created and destroyed for each (step of a) Helm action.

This can improve performance, but may cause issues with some Helm charts that for example do create Custom Resource Definitions during installation outside Helm’s CRD lifecycle hooks, which are then not observed to be available by e.g. post-install hooks.

If not set, it defaults to true.

Install holds the configuration for Helm install actions for this HelmRelease.

Upgrade holds the configuration for Helm upgrade actions for this HelmRelease.

Rollback holds the configuration for Helm rollback actions for this HelmRelease.

Uninstall holds the configuration for Helm uninstall actions for this HelmRelease.

ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged.

Values holds the values for this Helm release.

CommonMetadata specifies the common labels and annotations that are applied to all resources. Any existing label or annotation will be overridden if its key matches a common one.

DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled.

The interval at which to reconcile the Kustomization.

The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the KustomizationSpec.Interval value to retry failures.

Path to the directory containing the kustomization.yaml file, or the set of plain YAMLs a kustomization.yaml should be generated for. Defaults to ‘None’, which translates to the root path of the SourceRef.

Prune enables garbage collection.

Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors.

Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify.

This flag tells the controller to suspend subsequent kustomize executions, it does not apply to already started executions. Defaults to false.

TargetNamespace sets or overrides the namespace in the kustomization.yaml file.

Timeout for validation, apply and health checking operations. Defaults to ‘Interval’ duration.

Force instructs the controller to recreate resources when patching fails due to an immutable field change.

Components specifies relative paths to specifications of other Components.