Application (argoproj.io/v1alpha1)

Type: object

Application is a definition of Application resource.

Type: string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Type: string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Type: object

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: object

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

Each additional property must conform to the following schema

Type: string

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: integerFormat: int64

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Same definition as creationTimestamp

Type: array of string

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

No Additional Items

Each item of this array must be:

Type: string

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Type: integerFormat: int64

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Type: object

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

Each additional property must conform to the following schema

Type: string

Type: array

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Type: object

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Type: string

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

Type: string

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1

Type: object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

Type: string

Manager is an identifier of the workflow managing these fields.

Type: string

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

Type: string

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

Same definition as creationTimestamp

Type: string

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Type: array

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Type: object

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Type: boolean

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

Type: boolean

If true, this reference points to the managing controller.

Type: string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: string

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

Type: string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: object

Operation contains information about a requested or running operation

Type: array of object

Info is a list of informational items for this operation

No Additional Items

Each item of this array must be:

Type: object

Type: string

Type: string

Type: object

InitiatedBy contains information about who initiated the operations

Type: boolean

Automated is set to true if operation was initiated automatically by the application controller.

Type: string

Username contains the name of a user who started operation

Type: object

Retry controls the strategy to apply if a sync fails

Type: object

Backoff controls how to backoff on subsequent retries of failed syncs

Type: string

Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")

Type: integerFormat: int64

Factor is a factor to multiply the base duration after each failed retry

Type: string

MaxDuration is the maximum amount of time allowed for the backoff strategy

Type: integerFormat: int64

Limit is the maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.

Type: boolean

Refresh indicates if the latest revision should be used on retry instead of the initial one (default: false)

Type: object

Sync contains parameters for the operation

Type: integerFormat: int64

SelfHealAttemptsCount contains the number of auto-heal attempts

Type: boolean

DryRun specifies to perform a kubectl apply --dry-run without actually performing the sync

Type: array of string

Manifests is an optional field that overrides sync source with a local directory for development

No Additional Items

Each item of this array must be:

Type: boolean

Prune specifies to delete resources from the cluster that are no longer tracked in git

Type: array of object

Resources describes which resources shall be part of the sync

No Additional Items

Each item of this array must be:

Type: object

SyncOperationResource contains resources to sync.

Type: string

Revision is the revision (Git) or chart version (Helm) which to sync the application to
If omitted, will use the revision specified in app spec.

Type: array of string

Revisions is the list of revision (Git) or chart version (Helm) which to sync each source in sources field for the application to
If omitted, will use the revision specified in app spec.

No Additional Items

Each item of this array must be:

Type: object

Source overrides the source definition set in the application.
This is typically set in a Rollback operation and is nil during a Sync operation

Type: string

Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.

Type: object

Directory holds path/directory specific options

Type: string

Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation

Type: string

Include contains a glob pattern to match paths against that should be explicitly included during manifest generation

Type: object

Jsonnet holds options specific to Jsonnet

Type: array of object

ExtVars is a list of Jsonnet External Variables

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: array of string

Additional library search dirs

No Additional Items

Each item of this array must be:

Type: array of object

TLAS is a list of Jsonnet Top-level Arguments

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: boolean

Recurse specifies whether to scan a directory recursively for manifests

Type: object

Helm holds helm specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: array of object

FileParameters are file parameters to the helm template

No Additional Items

Each item of this array must be:

Type: object

HelmFileParameter is a file parameter that's passed to helm template during manifest generation

Type: string

Name is the name of the Helm parameter

Type: string

Path is the path to the file containing the values for the Helm parameter

Type: boolean

IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: string

Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.

Type: array of object

Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation

No Additional Items

Each item of this array must be:

Type: object

HelmParameter is a parameter that's passed to helm template during manifest generation

Type: boolean

ForceString determines whether to tell Helm to interpret booleans and numbers as strings

Type: string

Name is the name of the Helm parameter

Type: string

Value is the value for the Helm parameter

Type: boolean

PassCredentials pass credentials to all domains (Helm's --pass-credentials)

Type: string

ReleaseName is the Helm release name to use. If omitted it will use the application name

Type: boolean

SkipCrds skips custom resource definition installation step (Helm's --skip-crds)

Type: boolean

SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)

Type: boolean

SkipTests skips test manifest installation step (Helm's --skip-tests).

Type: array of string

ValuesFiles is a list of Helm value files to use when generating a template

No Additional Items

Each item of this array must be:

Type: string

Values specifies Helm values to be passed to helm template, typically defined as a block. ValuesObject takes precedence over Values, so use one or the other.

Type: object

ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.

Type: string

Version is the Helm version to use for templating ("3")

Type: object

Kustomize holds kustomize specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: object

CommonAnnotations is a list of additional annotations to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: boolean

CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values

Type: object

CommonLabels is a list of additional labels to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: array of string

Components specifies a list of kustomize components to add to the kustomization before building

No Additional Items

Each item of this array must be:

Type: boolean

ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps

Type: boolean

ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps

Type: boolean

IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file

Type: array of string

Images is a list of Kustomize image override specifications

No Additional Items

Each item of this array must be:

Type: string

KustomizeImage represents a Kustomize image definition in the format [oldimagename=]<image_name>:<image_tag>

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: boolean

LabelIncludeTemplates specifies whether to apply common labels to resource templates or not

Type: boolean

LabelWithoutSelector specifies whether to apply common labels to resource selectors or not

Type: string

NamePrefix is a prefix appended to resources for Kustomize apps

Type: string

NameSuffix is a suffix appended to resources for Kustomize apps

Type: string

Namespace sets the namespace that Kustomize adds to all resources

Type: array of object

Patches is a list of Kustomize patches

No Additional Items

Each item of this array must be:

Type: array of object

Replicas is a list of Kustomize Replicas override specifications

No Additional Items

Each item of this array must be:

Type: object

Type: object

Number of replicas

Type: string

Name of Deployment or StatefulSet

Type: string

Version controls which version of Kustomize to use for rendering manifests

Type: string

Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.

Type: string

Path is a directory path within the Git repository, and is only valid for applications sourced from Git.

Type: object

Plugin holds config management plugin specific options

Type: array of object

Env is a list of environment variable entries

No Additional Items

Each item of this array must be:

Type: object

EnvEntry represents an entry in the application's environment

Type: string

Name is the name of the variable, usually expressed in uppercase

Type: string

Value is the value of the variable

Type: string

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: array of string

Array is the value of an array type parameter.

No Additional Items

Each item of this array must be:

Type: object

Map is the value of a map type parameter.

Each additional property must conform to the following schema

Type: string

Type: string

Name is the name identifying a parameter.

Type: string

String_ is the value of a string type parameter.

Type: string

Ref is reference to another source within sources field. This field will not be used if used with a source tag.

Type: string

RepoURL is the URL to the repository (Git or Helm) that contains the application manifests

Type: string

TargetRevision defines the revision of the source to sync the application to.
In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD.
In case of Helm, this is a semver tag for the Chart's version.

Type: array of object

Sources overrides the source definition set in the application.
This is typically set in a Rollback operation and is nil during a Sync operation

No Additional Items

Each item of this array must be:

Type: object

ApplicationSource contains all required information about the source of an application

Type: string

Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.

Type: object

Directory holds path/directory specific options

Type: string

Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation

Type: string

Include contains a glob pattern to match paths against that should be explicitly included during manifest generation

Type: object

Jsonnet holds options specific to Jsonnet

Type: array of object

ExtVars is a list of Jsonnet External Variables

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: array of string

Additional library search dirs

No Additional Items

Each item of this array must be:

Type: array of object

TLAS is a list of Jsonnet Top-level Arguments

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: boolean

Recurse specifies whether to scan a directory recursively for manifests

Type: object

Helm holds helm specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: array of object

FileParameters are file parameters to the helm template

No Additional Items

Each item of this array must be:

Type: object

HelmFileParameter is a file parameter that's passed to helm template during manifest generation

Type: string

Name is the name of the Helm parameter

Type: string

Path is the path to the file containing the values for the Helm parameter

Type: boolean

IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: string

Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.

Type: array of object

Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation

No Additional Items

Each item of this array must be:

Type: object

HelmParameter is a parameter that's passed to helm template during manifest generation

Type: boolean

ForceString determines whether to tell Helm to interpret booleans and numbers as strings

Type: string

Name is the name of the Helm parameter

Type: string

Value is the value for the Helm parameter

Type: boolean

PassCredentials pass credentials to all domains (Helm's --pass-credentials)

Type: string

ReleaseName is the Helm release name to use. If omitted it will use the application name

Type: boolean

SkipCrds skips custom resource definition installation step (Helm's --skip-crds)

Type: boolean

SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)

Type: boolean

SkipTests skips test manifest installation step (Helm's --skip-tests).

Type: array of string

ValuesFiles is a list of Helm value files to use when generating a template

No Additional Items

Each item of this array must be:

Type: string

Values specifies Helm values to be passed to helm template, typically defined as a block. ValuesObject takes precedence over Values, so use one or the other.

Type: object

ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.

Type: string

Version is the Helm version to use for templating ("3")

Type: object

Kustomize holds kustomize specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: object

CommonAnnotations is a list of additional annotations to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: boolean

CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values

Type: object

CommonLabels is a list of additional labels to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: array of string

Components specifies a list of kustomize components to add to the kustomization before building

No Additional Items

Each item of this array must be:

Type: boolean

ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps

Type: boolean

ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps

Type: boolean

IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file

Type: array of string

Images is a list of Kustomize image override specifications

No Additional Items

Each item of this array must be:

Type: string

KustomizeImage represents a Kustomize image definition in the format [oldimagename=]<image_name>:<image_tag>

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: boolean

LabelIncludeTemplates specifies whether to apply common labels to resource templates or not

Type: boolean

LabelWithoutSelector specifies whether to apply common labels to resource selectors or not

Type: string

NamePrefix is a prefix appended to resources for Kustomize apps

Type: string

NameSuffix is a suffix appended to resources for Kustomize apps

Type: string

Namespace sets the namespace that Kustomize adds to all resources

Type: array of object

Patches is a list of Kustomize patches

No Additional Items

Each item of this array must be:

Type: array of object

Replicas is a list of Kustomize Replicas override specifications

No Additional Items

Each item of this array must be:

Type: object

Type: string

Name of Deployment or StatefulSet

Type: string

Version controls which version of Kustomize to use for rendering manifests

Type: string

Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.

Type: string

Path is a directory path within the Git repository, and is only valid for applications sourced from Git.

Type: object

Plugin holds config management plugin specific options

Type: array of object

Env is a list of environment variable entries

No Additional Items

Each item of this array must be:

Type: object

EnvEntry represents an entry in the application's environment

Type: string

Name is the name of the variable, usually expressed in uppercase

Type: string

Value is the value of the variable

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: array of string

Array is the value of an array type parameter.

No Additional Items

Each item of this array must be:

Type: object

Map is the value of a map type parameter.

Each additional property must conform to the following schema

Type: string

Type: string

Name is the name identifying a parameter.

Type: string

String_ is the value of a string type parameter.

Type: string

Ref is reference to another source within sources field. This field will not be used if used with a source tag.

Type: string

RepoURL is the URL to the repository (Git or Helm) that contains the application manifests

Type: string

TargetRevision defines the revision of the source to sync the application to.
In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD.
In case of Helm, this is a semver tag for the Chart's version.

Type: array of string

SyncOptions provide per-sync sync-options, e.g. Validate=false

No Additional Items

Each item of this array must be:

Type: object

SyncStrategy describes how to perform the sync

Type: object

Apply will perform a kubectl apply to perform the sync.

Type: boolean

Force indicates whether or not to supply the --force flag to kubectl apply.
The --force flag deletes and re-create the resource, when PATCH encounters conflict and has
retried for 5 times.

Type: object

Hook will submit any referenced resources to perform the sync. This is the default strategy

Type: boolean

Force indicates whether or not to supply the --force flag to kubectl apply.
The --force flag deletes and re-create the resource, when PATCH encounters conflict and has
retried for 5 times.

Type: object

ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.

Type: object

Destination is a reference to the target Kubernetes server and namespace

Type: string

Name is an alternate way of specifying the target cluster by its symbolic name. This must be set if Server is not set.

Type: string

Namespace specifies the target namespace for the application's resources.
The namespace will only be set for namespace-scoped resources that have not set a value for .metadata.namespace

Type: string

Server specifies the URL of the target cluster's Kubernetes control plane API. This must be set if Name is not set.

Type: array of object

IgnoreDifferences is a list of resources and their fields which should be ignored during comparison

No Additional Items

Each item of this array must be:

Type: object

ResourceIgnoreDifferences contains resource filter and list of json paths which should be ignored during comparison with live state.

Type: array of string
No Additional Items

Each item of this array must be:

Type: array of string
No Additional Items

Each item of this array must be:

Type: array of string

ManagedFieldsManagers is a list of trusted managers. Fields mutated by those managers will take precedence over the
desired state defined in the SCM and won't be displayed in diffs

No Additional Items

Each item of this array must be:

Type: array of object

Info contains a list of information (URLs, email addresses, and plain text) that relates to the application

No Additional Items

Each item of this array must be:

Type: object

Type: string

Type: string

Type: string

Project is a reference to the project this application belongs to.
The empty string means that application belongs to the 'default' project.

Type: integerFormat: int64

RevisionHistoryLimit limits the number of items kept in the application's revision history, which is used for informational purposes as well as for rollbacks to previous versions.
This should only be changed in exceptional circumstances.
Setting to zero will store no history. This will reduce storage used.
Increasing will increase the space used to store the history, so we do not recommend increasing it.
Default is 10.

Type: object

Source is a reference to the location of the application's manifests or chart

Type: string

Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.

Type: object

Directory holds path/directory specific options

Type: string

Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation

Type: string

Include contains a glob pattern to match paths against that should be explicitly included during manifest generation

Type: object

Jsonnet holds options specific to Jsonnet

Type: array of object

ExtVars is a list of Jsonnet External Variables

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: array of string

Additional library search dirs

No Additional Items

Each item of this array must be:

Type: array of object

TLAS is a list of Jsonnet Top-level Arguments

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: boolean

Recurse specifies whether to scan a directory recursively for manifests

Type: object

Helm holds helm specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: array of object

FileParameters are file parameters to the helm template

No Additional Items

Each item of this array must be:

Type: object

HelmFileParameter is a file parameter that's passed to helm template during manifest generation

Type: string

Name is the name of the Helm parameter

Type: string

Path is the path to the file containing the values for the Helm parameter

Type: boolean

IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: string

Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.

Type: array of object

Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation

No Additional Items

Each item of this array must be:

Type: object

HelmParameter is a parameter that's passed to helm template during manifest generation

Type: boolean

ForceString determines whether to tell Helm to interpret booleans and numbers as strings

Type: string

Name is the name of the Helm parameter

Type: string

Value is the value for the Helm parameter

Type: boolean

PassCredentials pass credentials to all domains (Helm's --pass-credentials)

Type: string

ReleaseName is the Helm release name to use. If omitted it will use the application name

Type: boolean

SkipCrds skips custom resource definition installation step (Helm's --skip-crds)

Type: boolean

SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)

Type: boolean

SkipTests skips test manifest installation step (Helm's --skip-tests).

Type: array of string

ValuesFiles is a list of Helm value files to use when generating a template

No Additional Items

Each item of this array must be:

Type: string

Values specifies Helm values to be passed to helm template, typically defined as a block. ValuesObject takes precedence over Values, so use one or the other.

Type: object

ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.

Type: string

Version is the Helm version to use for templating ("3")

Type: object

Kustomize holds kustomize specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: object

CommonAnnotations is a list of additional annotations to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: boolean

CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values

Type: object

CommonLabels is a list of additional labels to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: array of string

Components specifies a list of kustomize components to add to the kustomization before building

No Additional Items

Each item of this array must be:

Type: boolean

ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps

Type: boolean

ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps

Type: boolean

IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file

Type: array of string

Images is a list of Kustomize image override specifications

No Additional Items

Each item of this array must be:

Type: string

KustomizeImage represents a Kustomize image definition in the format [oldimagename=]<image_name>:<image_tag>

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: boolean

LabelIncludeTemplates specifies whether to apply common labels to resource templates or not

Type: boolean

LabelWithoutSelector specifies whether to apply common labels to resource selectors or not

Type: string

NamePrefix is a prefix appended to resources for Kustomize apps

Type: string

NameSuffix is a suffix appended to resources for Kustomize apps

Type: string

Namespace sets the namespace that Kustomize adds to all resources

Type: array of object

Patches is a list of Kustomize patches

No Additional Items

Each item of this array must be:

Type: object

Type: object

Each additional property must conform to the following schema

Type: boolean

Type: array of object

Replicas is a list of Kustomize Replicas override specifications

No Additional Items

Each item of this array must be:

Type: object

Type: object

Number of replicas

Type: string

Name of Deployment or StatefulSet

Type: string

Version controls which version of Kustomize to use for rendering manifests

Type: string

Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.

Type: string

Path is a directory path within the Git repository, and is only valid for applications sourced from Git.

Type: object

Plugin holds config management plugin specific options

Type: array of object

Env is a list of environment variable entries

No Additional Items

Each item of this array must be:

Type: object

EnvEntry represents an entry in the application's environment

Type: string

Name is the name of the variable, usually expressed in uppercase

Type: string

Value is the value of the variable

Type: string

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: array of string

Array is the value of an array type parameter.

No Additional Items

Each item of this array must be:

Type: object

Map is the value of a map type parameter.

Each additional property must conform to the following schema

Type: string

Type: string

Name is the name identifying a parameter.

Type: string

String_ is the value of a string type parameter.

Type: string

Ref is reference to another source within sources field. This field will not be used if used with a source tag.

Type: string

RepoURL is the URL to the repository (Git or Helm) that contains the application manifests

Type: string

TargetRevision defines the revision of the source to sync the application to.
In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD.
In case of Helm, this is a semver tag for the Chart's version.

Type: object

SourceHydrator provides a way to push hydrated manifests back to git before syncing them to the cluster.

Type: object

DrySource specifies where the dry "don't repeat yourself" manifest source lives.

Type: object

Directory specifies path/directory specific options

Type: string

Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation

Type: string

Include contains a glob pattern to match paths against that should be explicitly included during manifest generation

Type: object

Jsonnet holds options specific to Jsonnet

Type: array of object

ExtVars is a list of Jsonnet External Variables

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: array of string

Additional library search dirs

No Additional Items

Each item of this array must be:

Type: array of object

TLAS is a list of Jsonnet Top-level Arguments

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: boolean

Recurse specifies whether to scan a directory recursively for manifests

Type: object

Helm specifies helm specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: array of object

FileParameters are file parameters to the helm template

No Additional Items

Each item of this array must be:

Type: object

HelmFileParameter is a file parameter that's passed to helm template during manifest generation

Type: string

Name is the name of the Helm parameter

Type: string

Path is the path to the file containing the values for the Helm parameter

Type: boolean

IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: string

Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.

Type: array of object

Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation

No Additional Items

Each item of this array must be:

Type: object

HelmParameter is a parameter that's passed to helm template during manifest generation

Type: boolean

ForceString determines whether to tell Helm to interpret booleans and numbers as strings

Type: string

Name is the name of the Helm parameter

Type: string

Value is the value for the Helm parameter

Type: boolean

PassCredentials pass credentials to all domains (Helm's --pass-credentials)

Type: string

ReleaseName is the Helm release name to use. If omitted it will use the application name

Type: boolean

SkipCrds skips custom resource definition installation step (Helm's --skip-crds)

Type: boolean

SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)

Type: boolean

SkipTests skips test manifest installation step (Helm's --skip-tests).

Type: array of string

ValuesFiles is a list of Helm value files to use when generating a template

No Additional Items

Each item of this array must be:

Type: string

Values specifies Helm values to be passed to helm template, typically defined as a block. ValuesObject takes precedence over Values, so use one or the other.

Type: object

ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.

Type: string

Version is the Helm version to use for templating ("3")

Type: object

Kustomize specifies kustomize specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: object

CommonAnnotations is a list of additional annotations to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: boolean

CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values

Type: object

CommonLabels is a list of additional labels to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: array of string

Components specifies a list of kustomize components to add to the kustomization before building

No Additional Items

Each item of this array must be:

Type: boolean

ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps

Type: boolean

ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps

Type: boolean

IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file

Type: array of string

Images is a list of Kustomize image override specifications

No Additional Items

Each item of this array must be:

Type: string

KustomizeImage represents a Kustomize image definition in the format [oldimagename=]<image_name>:<image_tag>

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: boolean

LabelIncludeTemplates specifies whether to apply common labels to resource templates or not

Type: boolean

LabelWithoutSelector specifies whether to apply common labels to resource selectors or not

Type: string

NamePrefix is a prefix appended to resources for Kustomize apps

Type: string

NameSuffix is a suffix appended to resources for Kustomize apps

Type: string

Namespace sets the namespace that Kustomize adds to all resources

Type: array of object

Patches is a list of Kustomize patches

No Additional Items

Each item of this array must be:

Type: array of object

Replicas is a list of Kustomize Replicas override specifications

No Additional Items

Each item of this array must be:

Type: object

Type: object

Number of replicas

Type: string

Name of Deployment or StatefulSet

Type: string

Version controls which version of Kustomize to use for rendering manifests

Type: string

Path is a directory path within the Git repository where the manifests are located

Type: object

Plugin specifies config management plugin specific options

Type: array of object

Env is a list of environment variable entries

No Additional Items

Each item of this array must be:

Type: object

EnvEntry represents an entry in the application's environment

Type: string

Name is the name of the variable, usually expressed in uppercase

Type: string

Value is the value of the variable

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: array of string

Array is the value of an array type parameter.

No Additional Items

Each item of this array must be:

Type: object

Map is the value of a map type parameter.

Each additional property must conform to the following schema

Type: string

Type: string

Name is the name identifying a parameter.

Type: string

String_ is the value of a string type parameter.

Type: string

RepoURL is the URL to the git repository that contains the application manifests

Type: string

TargetRevision defines the revision of the source to hydrate

Type: object

HydrateTo specifies an optional "staging" location to push hydrated manifests to. An external system would then
have to move manifests to the SyncSource, e.g. by pull request.

Type: string

TargetBranch is the branch to which hydrated manifests should be committed

Type: object

SyncSource specifies where to sync hydrated manifests from.

Type: string

Path is a directory path within the git repository where hydrated manifests should be committed to and synced
from. The Path should never point to the root of the repo. If hydrateTo is set, this is just the path from which
hydrated manifests will be synced.

Must match regular expression: ^.{2,}|[^./]$

Must be at least 1 characters long

Type: string

TargetBranch is the branch from which hydrated manifests will be synced.
If HydrateTo is not set, this is also the branch to which hydrated manifests are committed.

Type: array of object

Sources is a reference to the location of the application's manifests or chart

No Additional Items

Each item of this array must be:

Type: object

ApplicationSource contains all required information about the source of an application

Type: string

Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.

Type: object

Directory holds path/directory specific options

Type: string

Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation

Type: string

Include contains a glob pattern to match paths against that should be explicitly included during manifest generation

Type: object

Jsonnet holds options specific to Jsonnet

Type: array of object

ExtVars is a list of Jsonnet External Variables

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: array of string

Additional library search dirs

No Additional Items

Each item of this array must be:

Type: array of object

TLAS is a list of Jsonnet Top-level Arguments

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: boolean

Recurse specifies whether to scan a directory recursively for manifests

Type: object

Helm holds helm specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: array of object

FileParameters are file parameters to the helm template

No Additional Items

Each item of this array must be:

Type: object

HelmFileParameter is a file parameter that's passed to helm template during manifest generation

Type: string

Name is the name of the Helm parameter

Type: string

Path is the path to the file containing the values for the Helm parameter

Type: boolean

IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: string

Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.

Type: array of object

Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation

No Additional Items

Each item of this array must be:

Type: object

HelmParameter is a parameter that's passed to helm template during manifest generation

Type: boolean

ForceString determines whether to tell Helm to interpret booleans and numbers as strings

Type: string

Name is the name of the Helm parameter

Type: string

Value is the value for the Helm parameter

Type: boolean

PassCredentials pass credentials to all domains (Helm's --pass-credentials)

Type: string

ReleaseName is the Helm release name to use. If omitted it will use the application name

Type: boolean

SkipCrds skips custom resource definition installation step (Helm's --skip-crds)

Type: boolean

SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)

Type: boolean

SkipTests skips test manifest installation step (Helm's --skip-tests).

Type: array of string

ValuesFiles is a list of Helm value files to use when generating a template

No Additional Items

Each item of this array must be:

Type: string

Values specifies Helm values to be passed to helm template, typically defined as a block. ValuesObject takes precedence over Values, so use one or the other.

Type: object

ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.

Type: string

Version is the Helm version to use for templating ("3")

Type: object

Kustomize holds kustomize specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: object

CommonAnnotations is a list of additional annotations to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: boolean

CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values

Type: object

CommonLabels is a list of additional labels to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: array of string

Components specifies a list of kustomize components to add to the kustomization before building

No Additional Items

Each item of this array must be:

Type: boolean

ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps

Type: boolean

ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps

Type: boolean

IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file

Type: array of string

Images is a list of Kustomize image override specifications

No Additional Items

Each item of this array must be:

Type: string

KustomizeImage represents a Kustomize image definition in the format [oldimagename=]<image_name>:<image_tag>

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: boolean

LabelIncludeTemplates specifies whether to apply common labels to resource templates or not

Type: boolean

LabelWithoutSelector specifies whether to apply common labels to resource selectors or not

Type: string

NamePrefix is a prefix appended to resources for Kustomize apps

Type: string

NameSuffix is a suffix appended to resources for Kustomize apps

Type: string

Namespace sets the namespace that Kustomize adds to all resources

Type: array of object

Patches is a list of Kustomize patches

No Additional Items

Each item of this array must be:

Type: array of object

Replicas is a list of Kustomize Replicas override specifications

No Additional Items

Each item of this array must be:

Type: object

Type: object

Number of replicas

Type: string

Name of Deployment or StatefulSet

Type: string

Version controls which version of Kustomize to use for rendering manifests

Type: string

Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.

Type: string

Path is a directory path within the Git repository, and is only valid for applications sourced from Git.

Type: object

Plugin holds config management plugin specific options

Type: array of object

Env is a list of environment variable entries

No Additional Items

Each item of this array must be:

Type: object

EnvEntry represents an entry in the application's environment

Type: string

Name is the name of the variable, usually expressed in uppercase

Type: string

Value is the value of the variable

Type: string

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: array of string

Array is the value of an array type parameter.

No Additional Items

Each item of this array must be:

Type: object

Map is the value of a map type parameter.

Each additional property must conform to the following schema

Type: string

Type: string

Name is the name identifying a parameter.

Type: string

String_ is the value of a string type parameter.

Type: string

Ref is reference to another source within sources field. This field will not be used if used with a source tag.

Type: string

RepoURL is the URL to the repository (Git or Helm) that contains the application manifests

Type: string

TargetRevision defines the revision of the source to sync the application to.
In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD.
In case of Helm, this is a semver tag for the Chart's version.

Type: object

SyncPolicy controls when and how a sync will be performed

Type: object

Automated will keep an application synced to the target revision

Type: boolean

AllowEmpty allows apps have zero live resources (default: false)

Type: boolean

Enable allows apps to explicitly control automated sync

Type: boolean

Prune specifies whether to delete resources from the cluster that are not found in the sources anymore as part of automated sync (default: false)

Type: boolean

SelfHeal specifies whether to revert resources back to their desired state upon modification in the cluster (default: false)

Type: object

ManagedNamespaceMetadata controls metadata in the given namespace (if CreateNamespace=true)

Type: object

Each additional property must conform to the following schema

Type: string

Type: object

Each additional property must conform to the following schema

Type: string

Type: object

Retry controls failed sync retry behavior

Type: object

Backoff controls how to backoff on subsequent retries of failed syncs

Type: string

Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")

Type: integerFormat: int64

Factor is a factor to multiply the base duration after each failed retry

Type: string

MaxDuration is the maximum amount of time allowed for the backoff strategy

Type: integerFormat: int64

Limit is the maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.

Type: boolean

Refresh indicates if the latest revision should be used on retry instead of the initial one (default: false)

Type: array of string

Options allow you to specify whole app sync-options

No Additional Items

Each item of this array must be:

Type: object

ApplicationStatus contains status information for the application

Type: array of object

Conditions is a list of currently observed application conditions

No Additional Items

Each item of this array must be:

Type: object

ApplicationCondition contains details about an application condition, which is usually an error or warning

Type: stringFormat: date-time

LastTransitionTime is the time the condition was last observed

Type: string

Message contains human-readable message indicating details about condition

Type: string

Type is an application condition type

Type: string

ControllerNamespace indicates the namespace in which the application controller is located

Type: object

Health contains information about the application's current health status

Type: stringFormat: date-time

LastTransitionTime is the time the HealthStatus was set or updated

Type: string

Message is a human-readable informational message describing the health status

Deprecated: this field is not used and will be removed in a future release.

Type: string

Status holds the status code of the application

Type: array of object

History contains information about the application's sync history

No Additional Items

Each item of this array must be:

Type: object

RevisionHistory contains history information about a previous sync

Type: stringFormat: date-time

DeployStartedAt holds the time the sync operation started

Type: stringFormat: date-time

DeployedAt holds the time the sync operation completed

Type: integerFormat: int64

ID is an auto incrementing identifier of the RevisionHistory

Type: object

InitiatedBy contains information about who initiated the operations

Type: boolean

Automated is set to true if operation was initiated automatically by the application controller.

Type: string

Username contains the name of a user who started operation

Type: string

Revision holds the revision the sync was performed against

Type: array of string

Revisions holds the revision of each source in sources field the sync was performed against

No Additional Items

Each item of this array must be:

Type: object

Source is a reference to the application source used for the sync operation

Type: string

Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.

Type: object

Directory holds path/directory specific options

Type: string

Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation

Type: string

Include contains a glob pattern to match paths against that should be explicitly included during manifest generation

Type: object

Jsonnet holds options specific to Jsonnet

Type: array of object

ExtVars is a list of Jsonnet External Variables

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: array of string

Additional library search dirs

No Additional Items

Each item of this array must be:

Type: array of object

TLAS is a list of Jsonnet Top-level Arguments

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: boolean

Recurse specifies whether to scan a directory recursively for manifests

Type: object

Helm holds helm specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: array of object

FileParameters are file parameters to the helm template

No Additional Items

Each item of this array must be:

Type: object

HelmFileParameter is a file parameter that's passed to helm template during manifest generation

Type: string

Name is the name of the Helm parameter

Type: string

Path is the path to the file containing the values for the Helm parameter

Type: boolean

IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: string

Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.

Type: array of object

Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation

No Additional Items

Each item of this array must be:

Type: object

HelmParameter is a parameter that's passed to helm template during manifest generation

Type: boolean

ForceString determines whether to tell Helm to interpret booleans and numbers as strings

Type: string

Name is the name of the Helm parameter

Type: string

Value is the value for the Helm parameter

Type: boolean

PassCredentials pass credentials to all domains (Helm's --pass-credentials)

Type: string

ReleaseName is the Helm release name to use. If omitted it will use the application name

Type: boolean

SkipCrds skips custom resource definition installation step (Helm's --skip-crds)

Type: boolean

SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)

Type: boolean

SkipTests skips test manifest installation step (Helm's --skip-tests).

Type: array of string

ValuesFiles is a list of Helm value files to use when generating a template

No Additional Items

Each item of this array must be:

Type: string

Values specifies Helm values to be passed to helm template, typically defined as a block. ValuesObject takes precedence over Values, so use one or the other.

Type: object

ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.

Type: string

Version is the Helm version to use for templating ("3")

Type: object

Kustomize holds kustomize specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: object

CommonAnnotations is a list of additional annotations to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: boolean

CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values

Type: object

CommonLabels is a list of additional labels to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: array of string

Components specifies a list of kustomize components to add to the kustomization before building

No Additional Items

Each item of this array must be:

Type: boolean

ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps

Type: boolean

ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps

Type: boolean

IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file

Type: array of string

Images is a list of Kustomize image override specifications

No Additional Items

Each item of this array must be:

Type: string

KustomizeImage represents a Kustomize image definition in the format [oldimagename=]<image_name>:<image_tag>

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: boolean

LabelIncludeTemplates specifies whether to apply common labels to resource templates or not

Type: boolean

LabelWithoutSelector specifies whether to apply common labels to resource selectors or not

Type: string

NamePrefix is a prefix appended to resources for Kustomize apps

Type: string

NameSuffix is a suffix appended to resources for Kustomize apps

Type: string

Namespace sets the namespace that Kustomize adds to all resources

Type: array of object

Patches is a list of Kustomize patches

No Additional Items

Each item of this array must be:

Type: array of object

Replicas is a list of Kustomize Replicas override specifications

No Additional Items

Each item of this array must be:

Type: object

Type: string

Name of Deployment or StatefulSet

Type: string

Version controls which version of Kustomize to use for rendering manifests

Type: string

Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.

Type: string

Path is a directory path within the Git repository, and is only valid for applications sourced from Git.

Type: object

Plugin holds config management plugin specific options

Type: array of object

Env is a list of environment variable entries

No Additional Items

Each item of this array must be:

Type: object

EnvEntry represents an entry in the application's environment

Type: string

Name is the name of the variable, usually expressed in uppercase

Type: string

Value is the value of the variable

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: array of string

Array is the value of an array type parameter.

No Additional Items

Each item of this array must be:

Type: object

Map is the value of a map type parameter.

Each additional property must conform to the following schema

Type: string

Type: string

Name is the name identifying a parameter.

Type: string

String_ is the value of a string type parameter.

Type: string

Ref is reference to another source within sources field. This field will not be used if used with a source tag.

Type: string

RepoURL is the URL to the repository (Git or Helm) that contains the application manifests

Type: string

TargetRevision defines the revision of the source to sync the application to.
In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD.
In case of Helm, this is a semver tag for the Chart's version.

Type: array of object

Sources is a reference to the application sources used for the sync operation

No Additional Items

Each item of this array must be:

Type: object

ApplicationSource contains all required information about the source of an application

Type: string

Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.

Type: object

Directory holds path/directory specific options

Type: string

Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation

Type: string

Include contains a glob pattern to match paths against that should be explicitly included during manifest generation

Type: object

Jsonnet holds options specific to Jsonnet

Type: array of object

ExtVars is a list of Jsonnet External Variables

No Additional Items

Each item of this array must be:

Type: array of string

Additional library search dirs

No Additional Items

Each item of this array must be:

Type: array of object

TLAS is a list of Jsonnet Top-level Arguments

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: boolean

Recurse specifies whether to scan a directory recursively for manifests

Type: object

Helm holds helm specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: array of object

FileParameters are file parameters to the helm template

No Additional Items

Each item of this array must be:

Type: object

HelmFileParameter is a file parameter that's passed to helm template during manifest generation

Type: string

Name is the name of the Helm parameter

Type: string

Path is the path to the file containing the values for the Helm parameter

Type: boolean

IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: string

Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.

Type: array of object

Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation

No Additional Items

Each item of this array must be:

Type: object

HelmParameter is a parameter that's passed to helm template during manifest generation

Type: boolean

ForceString determines whether to tell Helm to interpret booleans and numbers as strings

Type: string

Name is the name of the Helm parameter

Type: string

Value is the value for the Helm parameter

Type: boolean

PassCredentials pass credentials to all domains (Helm's --pass-credentials)

Type: string

ReleaseName is the Helm release name to use. If omitted it will use the application name

Type: boolean

SkipCrds skips custom resource definition installation step (Helm's --skip-crds)

Type: boolean

SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)

Type: boolean

SkipTests skips test manifest installation step (Helm's --skip-tests).

Type: array of string

ValuesFiles is a list of Helm value files to use when generating a template

No Additional Items

Each item of this array must be:

Type: string

Values specifies Helm values to be passed to helm template, typically defined as a block. ValuesObject takes precedence over Values, so use one or the other.

Type: object

ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.

Type: string

Version is the Helm version to use for templating ("3")

Type: object

Kustomize holds kustomize specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: object

CommonAnnotations is a list of additional annotations to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: boolean

CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values

Type: object

CommonLabels is a list of additional labels to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: array of string

Components specifies a list of kustomize components to add to the kustomization before building

No Additional Items

Each item of this array must be:

Type: boolean

ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps

Type: boolean

ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps

Type: boolean

IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file

Type: array of string

Images is a list of Kustomize image override specifications

No Additional Items

Each item of this array must be:

Type: string

KustomizeImage represents a Kustomize image definition in the format [oldimagename=]<image_name>:<image_tag>

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: boolean

LabelIncludeTemplates specifies whether to apply common labels to resource templates or not

Type: boolean

LabelWithoutSelector specifies whether to apply common labels to resource selectors or not

Type: string

NamePrefix is a prefix appended to resources for Kustomize apps

Type: string

NameSuffix is a suffix appended to resources for Kustomize apps

Type: string

Namespace sets the namespace that Kustomize adds to all resources

Type: array of object

Patches is a list of Kustomize patches

No Additional Items

Each item of this array must be:

Type: object

Type: object

Each additional property must conform to the following schema

Type: boolean

Type: array of object

Replicas is a list of Kustomize Replicas override specifications

No Additional Items

Each item of this array must be:

Type: object

Type: string

Name of Deployment or StatefulSet

Type: string

Version controls which version of Kustomize to use for rendering manifests

Type: string

Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.

Type: string

Path is a directory path within the Git repository, and is only valid for applications sourced from Git.

Type: object

Plugin holds config management plugin specific options

Type: array of object

Env is a list of environment variable entries

No Additional Items

Each item of this array must be:

Type: object

EnvEntry represents an entry in the application's environment

Type: string

Name is the name of the variable, usually expressed in uppercase

Type: string

Value is the value of the variable

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: array of string

Array is the value of an array type parameter.

No Additional Items

Each item of this array must be:

Type: object

Map is the value of a map type parameter.

Each additional property must conform to the following schema

Type: string

Type: string

Name is the name identifying a parameter.

Type: string

String_ is the value of a string type parameter.

Type: string

Ref is reference to another source within sources field. This field will not be used if used with a source tag.

Type: string

RepoURL is the URL to the repository (Git or Helm) that contains the application manifests

Type: string

TargetRevision defines the revision of the source to sync the application to.
In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD.
In case of Helm, this is a semver tag for the Chart's version.

Type: stringFormat: date-time

ObservedAt indicates when the application state was updated without querying latest git state
Deprecated: controller no longer updates ObservedAt field

Type: object

OperationState contains information about any ongoing operations, such as a sync

Type: stringFormat: date-time

FinishedAt contains time of operation completion

Type: string

Message holds any pertinent messages when attempting to perform operation (typically errors).

Type: object

Operation is the original requested operation

Type: array of object

Info is a list of informational items for this operation

No Additional Items

Each item of this array must be:

Type: object

Type: object

InitiatedBy contains information about who initiated the operations

Type: boolean

Automated is set to true if operation was initiated automatically by the application controller.

Type: string

Username contains the name of a user who started operation

Type: object

Retry controls the strategy to apply if a sync fails

Type: object

Backoff controls how to backoff on subsequent retries of failed syncs

Type: string

Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")

Type: integerFormat: int64

Factor is a factor to multiply the base duration after each failed retry

Type: string

MaxDuration is the maximum amount of time allowed for the backoff strategy

Type: integerFormat: int64

Limit is the maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.

Type: boolean

Refresh indicates if the latest revision should be used on retry instead of the initial one (default: false)

Type: object

Sync contains parameters for the operation

Type: integerFormat: int64

SelfHealAttemptsCount contains the number of auto-heal attempts

Type: boolean

DryRun specifies to perform a kubectl apply --dry-run without actually performing the sync

Type: array of string

Manifests is an optional field that overrides sync source with a local directory for development

No Additional Items

Each item of this array must be:

Type: boolean

Prune specifies to delete resources from the cluster that are no longer tracked in git

Type: array of object

Resources describes which resources shall be part of the sync

No Additional Items

Each item of this array must be:

Type: object

SyncOperationResource contains resources to sync.

Type: string

Revision is the revision (Git) or chart version (Helm) which to sync the application to
If omitted, will use the revision specified in app spec.

Type: array of string

Revisions is the list of revision (Git) or chart version (Helm) which to sync each source in sources field for the application to
If omitted, will use the revision specified in app spec.

No Additional Items

Each item of this array must be:

Type: object

Source overrides the source definition set in the application.
This is typically set in a Rollback operation and is nil during a Sync operation

Type: string

Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.

Type: object

Directory holds path/directory specific options

Type: string

Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation

Type: string

Include contains a glob pattern to match paths against that should be explicitly included during manifest generation

Type: object

Jsonnet holds options specific to Jsonnet

Type: array of object

ExtVars is a list of Jsonnet External Variables

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: array of string

Additional library search dirs

No Additional Items

Each item of this array must be:

Type: array of object

TLAS is a list of Jsonnet Top-level Arguments

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: boolean

Recurse specifies whether to scan a directory recursively for manifests

Type: object

Helm holds helm specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: array of object

FileParameters are file parameters to the helm template

No Additional Items

Each item of this array must be:

Type: object

HelmFileParameter is a file parameter that's passed to helm template during manifest generation

Type: string

Name is the name of the Helm parameter

Type: string

Path is the path to the file containing the values for the Helm parameter

Type: boolean

IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: string

Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.

Type: array of object

Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation

No Additional Items

Each item of this array must be:

Type: object

HelmParameter is a parameter that's passed to helm template during manifest generation

Type: boolean

ForceString determines whether to tell Helm to interpret booleans and numbers as strings

Type: string

Name is the name of the Helm parameter

Type: string

Value is the value for the Helm parameter

Type: boolean

PassCredentials pass credentials to all domains (Helm's --pass-credentials)

Type: string

ReleaseName is the Helm release name to use. If omitted it will use the application name

Type: boolean

SkipCrds skips custom resource definition installation step (Helm's --skip-crds)

Type: boolean

SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)

Type: boolean

SkipTests skips test manifest installation step (Helm's --skip-tests).

Type: array of string

ValuesFiles is a list of Helm value files to use when generating a template

No Additional Items

Each item of this array must be:

Type: string

Values specifies Helm values to be passed to helm template, typically defined as a block. ValuesObject takes precedence over Values, so use one or the other.

Type: object

ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.

Type: string

Version is the Helm version to use for templating ("3")

Type: object

Kustomize holds kustomize specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: object

CommonAnnotations is a list of additional annotations to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: boolean

CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values

Type: object

CommonLabels is a list of additional labels to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: array of string

Components specifies a list of kustomize components to add to the kustomization before building

No Additional Items

Each item of this array must be:

Type: boolean

ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps

Type: boolean

ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps

Type: boolean

IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file

Type: array of string

Images is a list of Kustomize image override specifications

No Additional Items

Each item of this array must be:

Type: string

KustomizeImage represents a Kustomize image definition in the format [oldimagename=]<image_name>:<image_tag>

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: boolean

LabelIncludeTemplates specifies whether to apply common labels to resource templates or not

Type: boolean

LabelWithoutSelector specifies whether to apply common labels to resource selectors or not

Type: string

NamePrefix is a prefix appended to resources for Kustomize apps

Type: string

NameSuffix is a suffix appended to resources for Kustomize apps

Type: string

Namespace sets the namespace that Kustomize adds to all resources

Type: array of object

Patches is a list of Kustomize patches

No Additional Items

Each item of this array must be:

Type: object

Type: object

Each additional property must conform to the following schema

Type: boolean

Type: array of object

Replicas is a list of Kustomize Replicas override specifications

No Additional Items

Each item of this array must be:

Type: object

Type: string

Name of Deployment or StatefulSet

Type: string

Version controls which version of Kustomize to use for rendering manifests

Type: string

Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.

Type: string

Path is a directory path within the Git repository, and is only valid for applications sourced from Git.

Type: object

Plugin holds config management plugin specific options

Type: array of object

Env is a list of environment variable entries

No Additional Items

Each item of this array must be:

Type: object

EnvEntry represents an entry in the application's environment

Type: string

Name is the name of the variable, usually expressed in uppercase

Type: string

Value is the value of the variable

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: array of string

Array is the value of an array type parameter.

No Additional Items

Each item of this array must be:

Type: object

Map is the value of a map type parameter.

Each additional property must conform to the following schema

Type: string

Type: string

Name is the name identifying a parameter.

Type: string

String_ is the value of a string type parameter.

Type: string

Ref is reference to another source within sources field. This field will not be used if used with a source tag.

Type: string

RepoURL is the URL to the repository (Git or Helm) that contains the application manifests

Type: string

TargetRevision defines the revision of the source to sync the application to.
In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD.
In case of Helm, this is a semver tag for the Chart's version.

Type: array of object

Sources overrides the source definition set in the application.
This is typically set in a Rollback operation and is nil during a Sync operation

No Additional Items

Each item of this array must be:

Type: object

ApplicationSource contains all required information about the source of an application

Type: string

Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.

Type: object

Directory holds path/directory specific options

Type: string

Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation

Type: string

Include contains a glob pattern to match paths against that should be explicitly included during manifest generation

Type: object

Jsonnet holds options specific to Jsonnet

Type: array of object

ExtVars is a list of Jsonnet External Variables

No Additional Items

Each item of this array must be:

Type: array of string

Additional library search dirs

No Additional Items

Each item of this array must be:

Type: array of object

TLAS is a list of Jsonnet Top-level Arguments

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: boolean

Recurse specifies whether to scan a directory recursively for manifests

Type: object

Helm holds helm specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: array of object

FileParameters are file parameters to the helm template

No Additional Items

Each item of this array must be:

Type: object

HelmFileParameter is a file parameter that's passed to helm template during manifest generation

Type: string

Name is the name of the Helm parameter

Type: string

Path is the path to the file containing the values for the Helm parameter

Type: boolean

IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: string

Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.

Type: array of object

Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation

No Additional Items

Each item of this array must be:

Type: object

HelmParameter is a parameter that's passed to helm template during manifest generation

Type: boolean

ForceString determines whether to tell Helm to interpret booleans and numbers as strings

Type: string

Name is the name of the Helm parameter

Type: string

Value is the value for the Helm parameter

Type: boolean

PassCredentials pass credentials to all domains (Helm's --pass-credentials)

Type: string

ReleaseName is the Helm release name to use. If omitted it will use the application name

Type: boolean

SkipCrds skips custom resource definition installation step (Helm's --skip-crds)

Type: boolean

SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)

Type: boolean

SkipTests skips test manifest installation step (Helm's --skip-tests).

Type: array of string

ValuesFiles is a list of Helm value files to use when generating a template

No Additional Items

Each item of this array must be:

Type: string

Values specifies Helm values to be passed to helm template, typically defined as a block. ValuesObject takes precedence over Values, so use one or the other.

Type: object

ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.

Type: string

Version is the Helm version to use for templating ("3")

Type: object

Kustomize holds kustomize specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: object

CommonAnnotations is a list of additional annotations to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: boolean

CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values

Type: object

CommonLabels is a list of additional labels to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: array of string

Components specifies a list of kustomize components to add to the kustomization before building

No Additional Items

Each item of this array must be:

Type: boolean

ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps

Type: boolean

ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps

Type: boolean

IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file

Type: array of string

Images is a list of Kustomize image override specifications

No Additional Items

Each item of this array must be:

Type: string

KustomizeImage represents a Kustomize image definition in the format [oldimagename=]<image_name>:<image_tag>

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: boolean

LabelIncludeTemplates specifies whether to apply common labels to resource templates or not

Type: boolean

LabelWithoutSelector specifies whether to apply common labels to resource selectors or not

Type: string

NamePrefix is a prefix appended to resources for Kustomize apps

Type: string

NameSuffix is a suffix appended to resources for Kustomize apps

Type: string

Namespace sets the namespace that Kustomize adds to all resources

Type: array of object

Patches is a list of Kustomize patches

No Additional Items

Each item of this array must be:

Type: object

Type: object

Each additional property must conform to the following schema

Type: boolean

Type: array of object

Replicas is a list of Kustomize Replicas override specifications

No Additional Items

Each item of this array must be:

Type: string

Version controls which version of Kustomize to use for rendering manifests

Type: string

Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.

Type: string

Path is a directory path within the Git repository, and is only valid for applications sourced from Git.

Type: object

Plugin holds config management plugin specific options

Type: array of object

Env is a list of environment variable entries

No Additional Items

Each item of this array must be:

Type: object

EnvEntry represents an entry in the application's environment

Type: string

Name is the name of the variable, usually expressed in uppercase

Type: string

Value is the value of the variable

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: array of string

Array is the value of an array type parameter.

No Additional Items

Each item of this array must be:

Type: object

Map is the value of a map type parameter.

Each additional property must conform to the following schema

Type: string

Type: string

Name is the name identifying a parameter.

Type: string

String_ is the value of a string type parameter.

Type: string

Ref is reference to another source within sources field. This field will not be used if used with a source tag.

Type: string

RepoURL is the URL to the repository (Git or Helm) that contains the application manifests

Type: string

TargetRevision defines the revision of the source to sync the application to.
In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD.
In case of Helm, this is a semver tag for the Chart's version.

Type: array of string

SyncOptions provide per-sync sync-options, e.g. Validate=false

No Additional Items

Each item of this array must be:

Type: object

SyncStrategy describes how to perform the sync

Type: object

Apply will perform a kubectl apply to perform the sync.

Type: boolean

Force indicates whether or not to supply the --force flag to kubectl apply.
The --force flag deletes and re-create the resource, when PATCH encounters conflict and has
retried for 5 times.

Type: object

Hook will submit any referenced resources to perform the sync. This is the default strategy

Type: boolean

Force indicates whether or not to supply the --force flag to kubectl apply.
The --force flag deletes and re-create the resource, when PATCH encounters conflict and has
retried for 5 times.

Type: string

Phase is the current phase of the operation

Type: integerFormat: int64

RetryCount contains time of operation retries

Type: stringFormat: date-time

StartedAt contains time of operation start

Type: object

SyncResult is the result of a Sync operation

Type: object

ManagedNamespaceMetadata contains the current sync state of managed namespace metadata

Type: object

Each additional property must conform to the following schema

Type: string

Type: object

Each additional property must conform to the following schema

Type: string

Type: array of object

Resources contains a list of sync result items for each individual resource in a sync operation

No Additional Items

Each item of this array must be:

Type: object

ResourceResult holds the operation result details of a specific resource

Type: string

Group specifies the API group of the resource

Type: string

HookPhase contains the state of any operation associated with this resource OR hook
This can also contain values for non-hook resources.

Type: string

HookType specifies the type of the hook. Empty for non-hook resources

Type: array of string

Images contains the images related to the ResourceResult

No Additional Items

Each item of this array must be:

Type: string

Kind specifies the API kind of the resource

Type: string

Message contains an informational or error message for the last sync OR operation

Type: string

Name specifies the name of the resource

Type: string

Namespace specifies the target namespace of the resource

Type: string

Status holds the final result of the sync. Will be empty if the resources is yet to be applied/pruned and is always zero-value for hooks

Type: string

SyncPhase indicates the particular phase of the sync that this result was acquired in

Type: string

Version specifies the API version of the resource

Type: string

Revision holds the revision this sync operation was performed to

Type: array of string

Revisions holds the revision this sync operation was performed for respective indexed source in sources field

No Additional Items

Each item of this array must be:

Type: object

Source records the application source information of the sync, used for comparing auto-sync

Type: string

Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.

Type: object

Directory holds path/directory specific options

Type: string

Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation

Type: string

Include contains a glob pattern to match paths against that should be explicitly included during manifest generation

Type: object

Jsonnet holds options specific to Jsonnet

Type: array of object

ExtVars is a list of Jsonnet External Variables

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: array of string

Additional library search dirs

No Additional Items

Each item of this array must be:

Type: array of object

TLAS is a list of Jsonnet Top-level Arguments

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: boolean

Recurse specifies whether to scan a directory recursively for manifests

Type: object

Helm holds helm specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: array of object

FileParameters are file parameters to the helm template

No Additional Items

Each item of this array must be:

Type: object

HelmFileParameter is a file parameter that's passed to helm template during manifest generation

Type: string

Name is the name of the Helm parameter

Type: string

Path is the path to the file containing the values for the Helm parameter

Type: boolean

IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: string

Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.

Type: array of object

Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation

No Additional Items

Each item of this array must be:

Type: object

HelmParameter is a parameter that's passed to helm template during manifest generation

Type: boolean

ForceString determines whether to tell Helm to interpret booleans and numbers as strings

Type: string

Name is the name of the Helm parameter

Type: string

Value is the value for the Helm parameter

Type: boolean

PassCredentials pass credentials to all domains (Helm's --pass-credentials)

Type: string

ReleaseName is the Helm release name to use. If omitted it will use the application name

Type: boolean

SkipCrds skips custom resource definition installation step (Helm's --skip-crds)

Type: boolean

SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)

Type: boolean

SkipTests skips test manifest installation step (Helm's --skip-tests).

Type: array of string

ValuesFiles is a list of Helm value files to use when generating a template

No Additional Items

Each item of this array must be:

Type: string

Values specifies Helm values to be passed to helm template, typically defined as a block. ValuesObject takes precedence over Values, so use one or the other.

Type: object

ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.

Type: string

Version is the Helm version to use for templating ("3")

Type: object

Kustomize holds kustomize specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: object

CommonAnnotations is a list of additional annotations to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: boolean

CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values

Type: object

CommonLabels is a list of additional labels to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: array of string

Components specifies a list of kustomize components to add to the kustomization before building

No Additional Items

Each item of this array must be:

Type: boolean

ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps

Type: boolean

ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps

Type: boolean

IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file

Type: array of string

Images is a list of Kustomize image override specifications

No Additional Items

Each item of this array must be:

Type: string

KustomizeImage represents a Kustomize image definition in the format [oldimagename=]<image_name>:<image_tag>

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: boolean

LabelIncludeTemplates specifies whether to apply common labels to resource templates or not

Type: boolean

LabelWithoutSelector specifies whether to apply common labels to resource selectors or not

Type: string

NamePrefix is a prefix appended to resources for Kustomize apps

Type: string

NameSuffix is a suffix appended to resources for Kustomize apps

Type: string

Namespace sets the namespace that Kustomize adds to all resources

Type: array of object

Patches is a list of Kustomize patches

No Additional Items

Each item of this array must be:

Type: object

Type: object

Each additional property must conform to the following schema

Type: boolean

Type: array of object

Replicas is a list of Kustomize Replicas override specifications

No Additional Items

Each item of this array must be:

Type: object

Type: string

Name of Deployment or StatefulSet

Type: string

Version controls which version of Kustomize to use for rendering manifests

Type: string

Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.

Type: string

Path is a directory path within the Git repository, and is only valid for applications sourced from Git.

Type: object

Plugin holds config management plugin specific options

Type: array of object

Env is a list of environment variable entries

No Additional Items

Each item of this array must be:

Type: object

EnvEntry represents an entry in the application's environment

Type: string

Name is the name of the variable, usually expressed in uppercase

Type: string

Value is the value of the variable

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: array of string

Array is the value of an array type parameter.

No Additional Items

Each item of this array must be:

Type: object

Map is the value of a map type parameter.

Each additional property must conform to the following schema

Type: string

Type: string

Name is the name identifying a parameter.

Type: string

String_ is the value of a string type parameter.

Type: string

Ref is reference to another source within sources field. This field will not be used if used with a source tag.

Type: string

RepoURL is the URL to the repository (Git or Helm) that contains the application manifests

Type: string

TargetRevision defines the revision of the source to sync the application to.
In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD.
In case of Helm, this is a semver tag for the Chart's version.

Type: array of object

Source records the application source information of the sync, used for comparing auto-sync

No Additional Items

Each item of this array must be:

Type: object

ApplicationSource contains all required information about the source of an application

Type: string

Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.

Type: object

Directory holds path/directory specific options

Type: string

Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation

Type: string

Include contains a glob pattern to match paths against that should be explicitly included during manifest generation

Type: object

Jsonnet holds options specific to Jsonnet

Type: array of object

ExtVars is a list of Jsonnet External Variables

No Additional Items

Each item of this array must be:

Type: array of string

Additional library search dirs

No Additional Items

Each item of this array must be:

Type: array of object

TLAS is a list of Jsonnet Top-level Arguments

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: boolean

Recurse specifies whether to scan a directory recursively for manifests

Type: object

Helm holds helm specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: array of object

FileParameters are file parameters to the helm template

No Additional Items

Each item of this array must be:

Type: object

HelmFileParameter is a file parameter that's passed to helm template during manifest generation

Type: string

Name is the name of the Helm parameter

Type: string

Path is the path to the file containing the values for the Helm parameter

Type: boolean

IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: string

Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.

Type: array of object

Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation

No Additional Items

Each item of this array must be:

Type: object

HelmParameter is a parameter that's passed to helm template during manifest generation

Type: boolean

ForceString determines whether to tell Helm to interpret booleans and numbers as strings

Type: string

Name is the name of the Helm parameter

Type: string

Value is the value for the Helm parameter

Type: boolean

PassCredentials pass credentials to all domains (Helm's --pass-credentials)

Type: string

ReleaseName is the Helm release name to use. If omitted it will use the application name

Type: boolean

SkipCrds skips custom resource definition installation step (Helm's --skip-crds)

Type: boolean

SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)

Type: boolean

SkipTests skips test manifest installation step (Helm's --skip-tests).

Type: array of string

ValuesFiles is a list of Helm value files to use when generating a template

No Additional Items

Each item of this array must be:

Type: string

Values specifies Helm values to be passed to helm template, typically defined as a block. ValuesObject takes precedence over Values, so use one or the other.

Type: object

ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.

Type: string

Version is the Helm version to use for templating ("3")

Type: object

Kustomize holds kustomize specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: object

CommonAnnotations is a list of additional annotations to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: boolean

CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values

Type: object

CommonLabels is a list of additional labels to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: array of string

Components specifies a list of kustomize components to add to the kustomization before building

No Additional Items

Each item of this array must be:

Type: boolean

ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps

Type: boolean

ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps

Type: boolean

IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file

Type: array of string

Images is a list of Kustomize image override specifications

No Additional Items

Each item of this array must be:

Type: string

KustomizeImage represents a Kustomize image definition in the format [oldimagename=]<image_name>:<image_tag>

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: boolean

LabelIncludeTemplates specifies whether to apply common labels to resource templates or not

Type: boolean

LabelWithoutSelector specifies whether to apply common labels to resource selectors or not

Type: string

NamePrefix is a prefix appended to resources for Kustomize apps

Type: string

NameSuffix is a suffix appended to resources for Kustomize apps

Type: string

Namespace sets the namespace that Kustomize adds to all resources

Type: array of object

Patches is a list of Kustomize patches

No Additional Items

Each item of this array must be:

Type: object

Type: object

Each additional property must conform to the following schema

Type: boolean

Type: array of object

Replicas is a list of Kustomize Replicas override specifications

No Additional Items

Each item of this array must be:

Type: string

Version controls which version of Kustomize to use for rendering manifests

Type: string

Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.

Type: string

Path is a directory path within the Git repository, and is only valid for applications sourced from Git.

Type: object

Plugin holds config management plugin specific options

Type: array of object

Env is a list of environment variable entries

No Additional Items

Each item of this array must be:

Type: object

EnvEntry represents an entry in the application's environment

Type: string

Name is the name of the variable, usually expressed in uppercase

Type: string

Value is the value of the variable

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: array of string

Array is the value of an array type parameter.

No Additional Items

Each item of this array must be:

Type: object

Map is the value of a map type parameter.

Each additional property must conform to the following schema

Type: string

Type: string

Name is the name identifying a parameter.

Type: string

String_ is the value of a string type parameter.

Type: string

Ref is reference to another source within sources field. This field will not be used if used with a source tag.

Type: string

RepoURL is the URL to the repository (Git or Helm) that contains the application manifests

Type: string

TargetRevision defines the revision of the source to sync the application to.
In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD.
In case of Helm, this is a semver tag for the Chart's version.

Type: stringFormat: date-time

ReconciledAt indicates when the application state was reconciled using the latest git version

Type: string

ResourceHealthSource indicates where the resource health status is stored: inline if not set or appTree

Type: array of object

Resources is a list of Kubernetes resources managed by this application

No Additional Items

Each item of this array must be:

Type: object

ResourceStatus holds the current synchronization and health status of a Kubernetes resource.

Type: string

Group represents the API group of the resource (e.g., "apps" for Deployments).

Type: object

Health indicates the health status of the resource (e.g., Healthy, Degraded, Progressing).

Type: stringFormat: date-time

LastTransitionTime is the time the HealthStatus was set or updated

Deprecated: this field is not used and will be removed in a future release.

Type: string

Message is a human-readable informational message describing the health status

Type: string

Status holds the status code of the resource

Type: boolean

Hook is true if the resource is used as a lifecycle hook in an Argo CD application.

Type: string

Kind specifies the type of the resource (e.g., "Deployment", "Service").

Type: string

Name is the unique name of the resource within the namespace.

Type: string

Namespace defines the Kubernetes namespace where the resource is located.

Type: boolean

RequiresDeletionConfirmation is true if the resource requires explicit user confirmation before deletion.

Type: boolean

RequiresPruning is true if the resource needs to be pruned (deleted) as part of synchronization.

Type: string

Status represents the synchronization state of the resource (e.g., Synced, OutOfSync).

Type: integerFormat: int64

SyncWave determines the order in which resources are applied during a sync operation.
Lower values are applied first.

Type: string

Version indicates the API version of the resource (e.g., "v1", "v1beta1").

Type: object

SourceHydrator stores information about the current state of source hydration

Type: object

CurrentOperation holds the status of the hydrate operation

Type: string

DrySHA holds the resolved revision (sha) of the dry source as of the most recent reconciliation

Type: stringFormat: date-time

FinishedAt indicates when the hydrate operation finished

Type: string

HydratedSHA holds the resolved revision (sha) of the hydrated source as of the most recent reconciliation

Type: string

Message contains a message describing the current status of the hydrate operation

Type: enum (of string)

Phase indicates the status of the hydrate operation

Must be one of:

  • "Hydrating"
  • "Failed"
  • "Hydrated"

Type: object

SourceHydrator holds the hydrator config used for the hydrate operation

Type: object

DrySource specifies where the dry "don't repeat yourself" manifest source lives.

Type: object

Directory specifies path/directory specific options

Type: string

Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation

Type: string

Include contains a glob pattern to match paths against that should be explicitly included during manifest generation

Type: object

Jsonnet holds options specific to Jsonnet

Type: array of object

ExtVars is a list of Jsonnet External Variables

No Additional Items

Each item of this array must be:

Type: array of string

Additional library search dirs

No Additional Items

Each item of this array must be:

Type: array of object

TLAS is a list of Jsonnet Top-level Arguments

No Additional Items

Each item of this array must be:

Type: boolean

Recurse specifies whether to scan a directory recursively for manifests

Type: object

Helm specifies helm specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: array of object

FileParameters are file parameters to the helm template

No Additional Items

Each item of this array must be:

Type: object

HelmFileParameter is a file parameter that's passed to helm template during manifest generation

Type: string

Path is the path to the file containing the values for the Helm parameter

Type: boolean

IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: string

Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.

Type: array of object

Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation

No Additional Items

Each item of this array must be:

Type: object

HelmParameter is a parameter that's passed to helm template during manifest generation

Type: boolean

ForceString determines whether to tell Helm to interpret booleans and numbers as strings

Type: string

Name is the name of the Helm parameter

Type: string

Value is the value for the Helm parameter

Type: boolean

PassCredentials pass credentials to all domains (Helm's --pass-credentials)

Type: string

ReleaseName is the Helm release name to use. If omitted it will use the application name

Type: boolean

SkipCrds skips custom resource definition installation step (Helm's --skip-crds)

Type: boolean

SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)

Type: boolean

SkipTests skips test manifest installation step (Helm's --skip-tests).

Type: array of string

ValuesFiles is a list of Helm value files to use when generating a template

No Additional Items

Each item of this array must be:

Type: string

Values specifies Helm values to be passed to helm template, typically defined as a block. ValuesObject takes precedence over Values, so use one or the other.

Type: object

ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.

Type: string

Version is the Helm version to use for templating ("3")

Type: object

Kustomize specifies kustomize specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: object

CommonAnnotations is a list of additional annotations to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: boolean

CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values

Type: object

CommonLabels is a list of additional labels to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: array of string

Components specifies a list of kustomize components to add to the kustomization before building

No Additional Items

Each item of this array must be:

Type: boolean

ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps

Type: boolean

ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps

Type: boolean

IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file

Type: array of string

Images is a list of Kustomize image override specifications

No Additional Items

Each item of this array must be:

Type: string

KustomizeImage represents a Kustomize image definition in the format [oldimagename=]<image_name>:<image_tag>

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: boolean

LabelIncludeTemplates specifies whether to apply common labels to resource templates or not

Type: boolean

LabelWithoutSelector specifies whether to apply common labels to resource selectors or not

Type: string

NamePrefix is a prefix appended to resources for Kustomize apps

Type: string

NameSuffix is a suffix appended to resources for Kustomize apps

Type: string

Namespace sets the namespace that Kustomize adds to all resources

Type: array of object

Patches is a list of Kustomize patches

No Additional Items

Each item of this array must be:

Type: object

Type: array of object

Replicas is a list of Kustomize Replicas override specifications

No Additional Items

Each item of this array must be:

Type: string

Version controls which version of Kustomize to use for rendering manifests

Type: string

Path is a directory path within the Git repository where the manifests are located

Type: object

Plugin specifies config management plugin specific options

Type: array of object

Env is a list of environment variable entries

No Additional Items

Each item of this array must be:

Type: object

EnvEntry represents an entry in the application's environment

Type: string

Name is the name of the variable, usually expressed in uppercase

Type: string

Value is the value of the variable

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: array of string

Array is the value of an array type parameter.

No Additional Items

Each item of this array must be:

Type: object

Map is the value of a map type parameter.

Each additional property must conform to the following schema

Type: string

Type: string

Name is the name identifying a parameter.

Type: string

String_ is the value of a string type parameter.

Type: string

RepoURL is the URL to the git repository that contains the application manifests

Type: string

TargetRevision defines the revision of the source to hydrate

Type: object

HydrateTo specifies an optional "staging" location to push hydrated manifests to. An external system would then
have to move manifests to the SyncSource, e.g. by pull request.

Type: string

TargetBranch is the branch to which hydrated manifests should be committed

Type: object

SyncSource specifies where to sync hydrated manifests from.

Type: string

Path is a directory path within the git repository where hydrated manifests should be committed to and synced
from. The Path should never point to the root of the repo. If hydrateTo is set, this is just the path from which
hydrated manifests will be synced.

Must match regular expression: ^.{2,}|[^./]$

Must be at least 1 characters long

Type: string

TargetBranch is the branch from which hydrated manifests will be synced.
If HydrateTo is not set, this is also the branch to which hydrated manifests are committed.

Type: stringFormat: date-time

StartedAt indicates when the hydrate operation started

Type: object

LastSuccessfulOperation holds info about the most recent successful hydration

Type: string

DrySHA holds the resolved revision (sha) of the dry source as of the most recent reconciliation

Type: string

HydratedSHA holds the resolved revision (sha) of the hydrated source as of the most recent reconciliation

Type: object

SourceHydrator holds the hydrator config used for the hydrate operation

Type: object

DrySource specifies where the dry "don't repeat yourself" manifest source lives.

Type: object

Directory specifies path/directory specific options

Type: string

Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation

Type: string

Include contains a glob pattern to match paths against that should be explicitly included during manifest generation

Type: object

Jsonnet holds options specific to Jsonnet

Type: array of object

ExtVars is a list of Jsonnet External Variables

No Additional Items

Each item of this array must be:

Type: array of string

Additional library search dirs

No Additional Items

Each item of this array must be:

Type: array of object

TLAS is a list of Jsonnet Top-level Arguments

No Additional Items

Each item of this array must be:

Type: boolean

Recurse specifies whether to scan a directory recursively for manifests

Type: object

Helm specifies helm specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: array of object

FileParameters are file parameters to the helm template

No Additional Items

Each item of this array must be:

Type: object

HelmFileParameter is a file parameter that's passed to helm template during manifest generation

Type: string

Path is the path to the file containing the values for the Helm parameter

Type: boolean

IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: string

Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.

Type: array of object

Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation

No Additional Items

Each item of this array must be:

Type: object

HelmParameter is a parameter that's passed to helm template during manifest generation

Type: boolean

ForceString determines whether to tell Helm to interpret booleans and numbers as strings

Type: string

Value is the value for the Helm parameter

Type: boolean

PassCredentials pass credentials to all domains (Helm's --pass-credentials)

Type: string

ReleaseName is the Helm release name to use. If omitted it will use the application name

Type: boolean

SkipCrds skips custom resource definition installation step (Helm's --skip-crds)

Type: boolean

SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)

Type: boolean

SkipTests skips test manifest installation step (Helm's --skip-tests).

Type: array of string

ValuesFiles is a list of Helm value files to use when generating a template

No Additional Items

Each item of this array must be:

Type: string

Values specifies Helm values to be passed to helm template, typically defined as a block. ValuesObject takes precedence over Values, so use one or the other.

Type: object

ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.

Type: string

Version is the Helm version to use for templating ("3")

Type: object

Kustomize specifies kustomize specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: object

CommonAnnotations is a list of additional annotations to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: boolean

CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values

Type: object

CommonLabels is a list of additional labels to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: array of string

Components specifies a list of kustomize components to add to the kustomization before building

No Additional Items

Each item of this array must be:

Type: boolean

ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps

Type: boolean

ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps

Type: boolean

IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file

Type: array of string

Images is a list of Kustomize image override specifications

No Additional Items

Each item of this array must be:

Type: string

KustomizeImage represents a Kustomize image definition in the format [oldimagename=]<image_name>:<image_tag>

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: boolean

LabelIncludeTemplates specifies whether to apply common labels to resource templates or not

Type: boolean

LabelWithoutSelector specifies whether to apply common labels to resource selectors or not

Type: string

NamePrefix is a prefix appended to resources for Kustomize apps

Type: string

NameSuffix is a suffix appended to resources for Kustomize apps

Type: string

Namespace sets the namespace that Kustomize adds to all resources

Type: array of object

Patches is a list of Kustomize patches

No Additional Items

Each item of this array must be:

Type: object

Type: array of object

Replicas is a list of Kustomize Replicas override specifications

No Additional Items

Each item of this array must be:

Type: string

Version controls which version of Kustomize to use for rendering manifests

Type: string

Path is a directory path within the Git repository where the manifests are located

Type: object

Plugin specifies config management plugin specific options

Type: array of object

Env is a list of environment variable entries

No Additional Items

Each item of this array must be:

Type: object

EnvEntry represents an entry in the application's environment

Type: string

Name is the name of the variable, usually expressed in uppercase

Type: string

Value is the value of the variable

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: array of string

Array is the value of an array type parameter.

No Additional Items

Each item of this array must be:

Type: object

Map is the value of a map type parameter.

Each additional property must conform to the following schema

Type: string

Type: string

Name is the name identifying a parameter.

Type: string

String_ is the value of a string type parameter.

Type: string

RepoURL is the URL to the git repository that contains the application manifests

Type: string

TargetRevision defines the revision of the source to hydrate

Type: object

HydrateTo specifies an optional "staging" location to push hydrated manifests to. An external system would then
have to move manifests to the SyncSource, e.g. by pull request.

Type: string

TargetBranch is the branch to which hydrated manifests should be committed

Type: object

SyncSource specifies where to sync hydrated manifests from.

Type: string

Path is a directory path within the git repository where hydrated manifests should be committed to and synced
from. The Path should never point to the root of the repo. If hydrateTo is set, this is just the path from which
hydrated manifests will be synced.

Must match regular expression: ^.{2,}|[^./]$

Must be at least 1 characters long

Type: string

TargetBranch is the branch from which hydrated manifests will be synced.
If HydrateTo is not set, this is also the branch to which hydrated manifests are committed.

Type: string

SourceType specifies the type of this application

Type: array of string

SourceTypes specifies the type of the sources included in the application

No Additional Items

Each item of this array must be:

Type: string

ApplicationSourceType specifies the type of the application's source

Type: object

Summary contains a list of URLs and container images used by this application

Type: array of string

ExternalURLs holds all external URLs of application child resources.

No Additional Items

Each item of this array must be:

Type: array of string

Images holds all images of application child resources.

No Additional Items

Each item of this array must be:

Type: string

Type: object

Sync contains information about the application's current sync status

Type: object

ComparedTo contains information about what has been compared

Type: object

Destination is a reference to the application's destination used for comparison

Type: string

Name is an alternate way of specifying the target cluster by its symbolic name. This must be set if Server is not set.

Type: string

Namespace specifies the target namespace for the application's resources.
The namespace will only be set for namespace-scoped resources that have not set a value for .metadata.namespace

Type: string

Server specifies the URL of the target cluster's Kubernetes control plane API. This must be set if Name is not set.

Type: array of object

IgnoreDifferences is a reference to the application's ignored differences used for comparison

No Additional Items

Each item of this array must be:

Type: object

ResourceIgnoreDifferences contains resource filter and list of json paths which should be ignored during comparison with live state.

Type: array of string
No Additional Items

Each item of this array must be:

Type: array of string

ManagedFieldsManagers is a list of trusted managers. Fields mutated by those managers will take precedence over the
desired state defined in the SCM and won't be displayed in diffs

No Additional Items

Each item of this array must be:

Type: object

Source is a reference to the application's source used for comparison

Type: string

Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.

Type: object

Directory holds path/directory specific options

Type: string

Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation

Type: string

Include contains a glob pattern to match paths against that should be explicitly included during manifest generation

Type: object

Jsonnet holds options specific to Jsonnet

Type: array of object

ExtVars is a list of Jsonnet External Variables

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: array of string

Additional library search dirs

No Additional Items

Each item of this array must be:

Type: array of object

TLAS is a list of Jsonnet Top-level Arguments

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: boolean

Recurse specifies whether to scan a directory recursively for manifests

Type: object

Helm holds helm specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: array of object

FileParameters are file parameters to the helm template

No Additional Items

Each item of this array must be:

Type: object

HelmFileParameter is a file parameter that's passed to helm template during manifest generation

Type: string

Name is the name of the Helm parameter

Type: string

Path is the path to the file containing the values for the Helm parameter

Type: boolean

IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: string

Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.

Type: array of object

Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation

No Additional Items

Each item of this array must be:

Type: object

HelmParameter is a parameter that's passed to helm template during manifest generation

Type: boolean

ForceString determines whether to tell Helm to interpret booleans and numbers as strings

Type: string

Name is the name of the Helm parameter

Type: string

Value is the value for the Helm parameter

Type: boolean

PassCredentials pass credentials to all domains (Helm's --pass-credentials)

Type: string

ReleaseName is the Helm release name to use. If omitted it will use the application name

Type: boolean

SkipCrds skips custom resource definition installation step (Helm's --skip-crds)

Type: boolean

SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)

Type: boolean

SkipTests skips test manifest installation step (Helm's --skip-tests).

Type: array of string

ValuesFiles is a list of Helm value files to use when generating a template

No Additional Items

Each item of this array must be:

Type: string

Values specifies Helm values to be passed to helm template, typically defined as a block. ValuesObject takes precedence over Values, so use one or the other.

Type: object

ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.

Type: string

Version is the Helm version to use for templating ("3")

Type: object

Kustomize holds kustomize specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: object

CommonAnnotations is a list of additional annotations to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: boolean

CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values

Type: object

CommonLabels is a list of additional labels to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: array of string

Components specifies a list of kustomize components to add to the kustomization before building

No Additional Items

Each item of this array must be:

Type: boolean

ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps

Type: boolean

ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps

Type: boolean

IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file

Type: array of string

Images is a list of Kustomize image override specifications

No Additional Items

Each item of this array must be:

Type: string

KustomizeImage represents a Kustomize image definition in the format [oldimagename=]<image_name>:<image_tag>

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: boolean

LabelIncludeTemplates specifies whether to apply common labels to resource templates or not

Type: boolean

LabelWithoutSelector specifies whether to apply common labels to resource selectors or not

Type: string

NamePrefix is a prefix appended to resources for Kustomize apps

Type: string

NameSuffix is a suffix appended to resources for Kustomize apps

Type: string

Namespace sets the namespace that Kustomize adds to all resources

Type: array of object

Patches is a list of Kustomize patches

No Additional Items

Each item of this array must be:

Type: array of object

Replicas is a list of Kustomize Replicas override specifications

No Additional Items

Each item of this array must be:

Type: object

Type: object

Number of replicas

Type: string

Name of Deployment or StatefulSet

Type: string

Version controls which version of Kustomize to use for rendering manifests

Type: string

Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.

Type: string

Path is a directory path within the Git repository, and is only valid for applications sourced from Git.

Type: object

Plugin holds config management plugin specific options

Type: array of object

Env is a list of environment variable entries

No Additional Items

Each item of this array must be:

Type: object

EnvEntry represents an entry in the application's environment

Type: string

Name is the name of the variable, usually expressed in uppercase

Type: string

Value is the value of the variable

Type: string

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: array of string

Array is the value of an array type parameter.

No Additional Items

Each item of this array must be:

Type: object

Map is the value of a map type parameter.

Each additional property must conform to the following schema

Type: string

Type: string

Name is the name identifying a parameter.

Type: string

String_ is the value of a string type parameter.

Type: string

Ref is reference to another source within sources field. This field will not be used if used with a source tag.

Type: string

RepoURL is the URL to the repository (Git or Helm) that contains the application manifests

Type: string

TargetRevision defines the revision of the source to sync the application to.
In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD.
In case of Helm, this is a semver tag for the Chart's version.

Type: array of object

Sources is a reference to the application's multiple sources used for comparison

No Additional Items

Each item of this array must be:

Type: object

ApplicationSource contains all required information about the source of an application

Type: string

Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.

Type: object

Directory holds path/directory specific options

Type: string

Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation

Type: string

Include contains a glob pattern to match paths against that should be explicitly included during manifest generation

Type: object

Jsonnet holds options specific to Jsonnet

Type: array of object

ExtVars is a list of Jsonnet External Variables

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: array of string

Additional library search dirs

No Additional Items

Each item of this array must be:

Type: array of object

TLAS is a list of Jsonnet Top-level Arguments

No Additional Items

Each item of this array must be:

Type: object

JsonnetVar represents a variable to be passed to jsonnet during manifest generation

Type: boolean

Recurse specifies whether to scan a directory recursively for manifests

Type: object

Helm holds helm specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: array of object

FileParameters are file parameters to the helm template

No Additional Items

Each item of this array must be:

Type: object

HelmFileParameter is a file parameter that's passed to helm template during manifest generation

Type: string

Name is the name of the Helm parameter

Type: string

Path is the path to the file containing the values for the Helm parameter

Type: boolean

IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: string

Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.

Type: array of object

Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation

No Additional Items

Each item of this array must be:

Type: object

HelmParameter is a parameter that's passed to helm template during manifest generation

Type: boolean

ForceString determines whether to tell Helm to interpret booleans and numbers as strings

Type: string

Name is the name of the Helm parameter

Type: string

Value is the value for the Helm parameter

Type: boolean

PassCredentials pass credentials to all domains (Helm's --pass-credentials)

Type: string

ReleaseName is the Helm release name to use. If omitted it will use the application name

Type: boolean

SkipCrds skips custom resource definition installation step (Helm's --skip-crds)

Type: boolean

SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)

Type: boolean

SkipTests skips test manifest installation step (Helm's --skip-tests).

Type: array of string

ValuesFiles is a list of Helm value files to use when generating a template

No Additional Items

Each item of this array must be:

Type: string

Values specifies Helm values to be passed to helm template, typically defined as a block. ValuesObject takes precedence over Values, so use one or the other.

Type: object

ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.

Type: string

Version is the Helm version to use for templating ("3")

Type: object

Kustomize holds kustomize specific options

Type: array of string

APIVersions specifies the Kubernetes resource API versions to pass to Helm when templating manifests. By default,
Argo CD uses the API versions of the target cluster. The format is [group/]version/kind.

No Additional Items

Each item of this array must be:

Type: object

CommonAnnotations is a list of additional annotations to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: boolean

CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values

Type: object

CommonLabels is a list of additional labels to add to rendered manifests

Each additional property must conform to the following schema

Type: string

Type: array of string

Components specifies a list of kustomize components to add to the kustomization before building

No Additional Items

Each item of this array must be:

Type: boolean

ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps

Type: boolean

ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps

Type: boolean

IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file

Type: array of string

Images is a list of Kustomize image override specifications

No Additional Items

Each item of this array must be:

Type: string

KustomizeImage represents a Kustomize image definition in the format [oldimagename=]<image_name>:<image_tag>

Type: string

KubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD
uses the Kubernetes version of the target cluster.

Type: boolean

LabelIncludeTemplates specifies whether to apply common labels to resource templates or not

Type: boolean

LabelWithoutSelector specifies whether to apply common labels to resource selectors or not

Type: string

NamePrefix is a prefix appended to resources for Kustomize apps

Type: string

NameSuffix is a suffix appended to resources for Kustomize apps

Type: string

Namespace sets the namespace that Kustomize adds to all resources

Type: array of object

Patches is a list of Kustomize patches

No Additional Items

Each item of this array must be:

Type: object

Type: object

Each additional property must conform to the following schema

Type: boolean

Type: array of object

Replicas is a list of Kustomize Replicas override specifications

No Additional Items

Each item of this array must be:

Type: object

Type: string

Name of Deployment or StatefulSet

Type: string

Version controls which version of Kustomize to use for rendering manifests

Type: string

Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.

Type: string

Path is a directory path within the Git repository, and is only valid for applications sourced from Git.

Type: object

Plugin holds config management plugin specific options

Type: array of object

Env is a list of environment variable entries

No Additional Items

Each item of this array must be:

Type: object

EnvEntry represents an entry in the application's environment

Type: string

Name is the name of the variable, usually expressed in uppercase

Type: string

Value is the value of the variable

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: array of string

Array is the value of an array type parameter.

No Additional Items

Each item of this array must be:

Type: object

Map is the value of a map type parameter.

Each additional property must conform to the following schema

Type: string

Type: string

Name is the name identifying a parameter.

Type: string

String_ is the value of a string type parameter.

Type: string

Ref is reference to another source within sources field. This field will not be used if used with a source tag.

Type: string

RepoURL is the URL to the repository (Git or Helm) that contains the application manifests

Type: string

TargetRevision defines the revision of the source to sync the application to.
In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD.
In case of Helm, this is a semver tag for the Chart's version.

Type: string

Revision contains information about the revision the comparison has been performed to

Type: array of string

Revisions contains information about the revisions of multiple sources the comparison has been performed to

No Additional Items

Each item of this array must be:

Type: string

Status is the sync state of the comparison