Application

io.argoproj.v1alpha1.Application

Application is a definition of Application resource.

apiVersionstring = "argoproj.io/v1alpha1"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
kindstring = "Application"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
metadataobject required
operationobjectOperation contains information about a requested or running operation
info[]objectInfo is a list of informational items for this operation
namestring required
valuestring required
initiatedByobjectInitiatedBy contains information about who initiated the operations
automatedbooleanAutomated is set to true if operation was initiated automatically by the application controller.
usernamestringUsername contains the name of a user who started operation
retryobjectRetry controls the strategy to apply if a sync fails
backoffobjectBackoff controls how to backoff on subsequent retries of failed syncs
durationstringDuration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")
factorinteger (int64)Factor is a factor to multiply the base duration after each failed retry
maxDurationstringMaxDuration is the maximum amount of time allowed for the backoff strategy
limitinteger (int64)Limit is the maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.
refreshbooleanRefresh indicates if the latest revision should be used on retry instead of the initial one (default: false)
syncobjectSync contains parameters for the operation
autoHealAttemptsCountinteger (int64)SelfHealAttemptsCount contains the number of auto-heal attempts
dryRunbooleanDryRun specifies to perform a `kubectl apply --dry-run` without actually performing the sync
manifests[]stringManifests is an optional field that overrides sync source with a local directory for development
prunebooleanPrune specifies to delete resources from the cluster that are no longer tracked in git
resources[]objectResources describes which resources shall be part of the sync
groupstring
kindstring required
namestring required
namespacestring
revisionstring or revisionsRevision is the revision (Git) or chart version (Helm) which to sync the application to If omitted, will use the revision specified in app spec.
sourceobject or sourcesSource overrides the source definition set in the application. This is typically set in a Rollback operation and is nil during a Sync operation
chartstringChart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directoryobjectDirectory holds path/directory specific options
excludestringExclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
includestringInclude contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnetobjectJsonnet holds options specific to Jsonnet
extVars[]objectExtVars is a list of Jsonnet External Variables
codeboolean
namestring required
valuestring required
libs[]stringAdditional library search dirs
tlas[]objectTLAS is a list of Jsonnet Top-level Arguments
codeboolean
namestring required
valuestring required
recursebooleanRecurse specifies whether to scan a directory recursively for manifests
helmobjectHelm holds helm specific options
apiVersions[]stringAPIVersions 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.
fileParameters[]objectFileParameters are file parameters to the helm template
namestringName is the name of the Helm parameter
pathstringPath is the path to the file containing the values for the Helm parameter
ignoreMissingValueFilesbooleanIgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersionstringKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
namespacestringNamespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters[]objectParameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceStringbooleanForceString determines whether to tell Helm to interpret booleans and numbers as strings
namestringName is the name of the Helm parameter
valuestringValue is the value for the Helm parameter
passCredentialsbooleanPassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseNamestringReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrdsbooleanSkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidationbooleanSkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTestsbooleanSkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles[]stringValuesFiles is a list of Helm value files to use when generating a template
valuesstringValues 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.
valuesObjectobjectValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
versionstringVersion is the Helm version to use for templating ("3")
kustomizeobjectKustomize holds kustomize specific options
apiVersions[]stringAPIVersions 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.
commonAnnotationsmap[string]stringCommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubstbooleanCommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabelsmap[string]stringCommonLabels is a list of additional labels to add to rendered manifests
components[]stringComponents specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotationsbooleanForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabelsbooleanForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponentsbooleanIgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images[]stringImages is a list of Kustomize image override specifications
kubeVersionstringKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
labelIncludeTemplatesbooleanLabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelectorbooleanLabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefixstringNamePrefix overrides the namePrefix in the kustomization.yaml for Kustomize apps
nameSuffixstringNameSuffix overrides the nameSuffix in the kustomization.yaml for Kustomize apps
namespacestringNamespace sets the namespace that Kustomize adds to all resources
patches[]objectPatches is a list of Kustomize patches
optionsmap[string]boolean
patchstring
pathstring
targetobject
annotationSelectorstring
groupstring
kindstring
labelSelectorstring
namestring
namespacestring
versionstring
replicas[]objectReplicas is a list of Kustomize Replicas override specifications
countobject requiredNumber of replicas
namestring requiredName of Deployment or StatefulSet
versionstringVersion controls which version of Kustomize to use for rendering manifests
namestringName is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
pathstringPath is a directory path within the Git repository, and is only valid for applications sourced from Git.
pluginobjectPlugin holds config management plugin specific options
env[]objectEnv is a list of environment variable entries
namestring requiredName is the name of the variable, usually expressed in uppercase
valuestring requiredValue is the value of the variable
namestring
parameters[]object
array[]stringArray is the value of an array type parameter.
mapmap[string]stringMap is the value of a map type parameter.
namestringName is the name identifying a parameter.
stringstringString_ is the value of a string type parameter.
refstringRef is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURLstring requiredRepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevisionstringTargetRevision 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.
syncOptions[]stringSyncOptions provide per-sync sync-options, e.g. Validate=false
syncStrategyobjectSyncStrategy describes how to perform the sync
applyobjectApply will perform a `kubectl apply` to perform the sync.
forcebooleanForce 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.
hookobjectHook will submit any referenced resources to perform the sync. This is the default strategy
forcebooleanForce 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.
specobject requiredApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
destinationobject requiredDestination is a reference to the target Kubernetes server and namespace
namestringName is an alternate way of specifying the target cluster by its symbolic name. This must be set if Server is not set.
namespacestringNamespace 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
serverstringServer specifies the URL of the target cluster's Kubernetes control plane API. This must be set if Name is not set.
ignoreDifferences[]objectIgnoreDifferences is a list of resources and their fields which should be ignored during comparison
groupstring
jqPathExpressions[]string
jsonPointers[]string
kindstring required
managedFieldsManagers[]stringManagedFieldsManagers 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
namestring
namespacestring
info[]objectInfo contains a list of information (URLs, email addresses, and plain text) that relates to the application
namestring required
valuestring required
projectstring requiredProject is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project.
revisionHistoryLimitinteger (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.
sourceobject or sourcesSource is a reference to the location of the application's manifests or chart
chartstringChart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directoryobjectDirectory holds path/directory specific options
excludestringExclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
includestringInclude contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnetobjectJsonnet holds options specific to Jsonnet
extVars[]objectExtVars is a list of Jsonnet External Variables
codeboolean
namestring required
valuestring required
libs[]stringAdditional library search dirs
tlas[]objectTLAS is a list of Jsonnet Top-level Arguments
codeboolean
namestring required
valuestring required
recursebooleanRecurse specifies whether to scan a directory recursively for manifests
helmobjectHelm holds helm specific options
apiVersions[]stringAPIVersions 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.
fileParameters[]objectFileParameters are file parameters to the helm template
namestringName is the name of the Helm parameter
pathstringPath is the path to the file containing the values for the Helm parameter
ignoreMissingValueFilesbooleanIgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersionstringKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
namespacestringNamespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters[]objectParameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceStringbooleanForceString determines whether to tell Helm to interpret booleans and numbers as strings
namestringName is the name of the Helm parameter
valuestringValue is the value for the Helm parameter
passCredentialsbooleanPassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseNamestringReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrdsbooleanSkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidationbooleanSkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTestsbooleanSkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles[]stringValuesFiles is a list of Helm value files to use when generating a template
valuesstringValues 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.
valuesObjectobjectValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
versionstringVersion is the Helm version to use for templating ("3")
kustomizeobjectKustomize holds kustomize specific options
apiVersions[]stringAPIVersions 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.
commonAnnotationsmap[string]stringCommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubstbooleanCommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabelsmap[string]stringCommonLabels is a list of additional labels to add to rendered manifests
components[]stringComponents specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotationsbooleanForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabelsbooleanForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponentsbooleanIgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images[]stringImages is a list of Kustomize image override specifications
kubeVersionstringKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
labelIncludeTemplatesbooleanLabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelectorbooleanLabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefixstringNamePrefix overrides the namePrefix in the kustomization.yaml for Kustomize apps
nameSuffixstringNameSuffix overrides the nameSuffix in the kustomization.yaml for Kustomize apps
namespacestringNamespace sets the namespace that Kustomize adds to all resources
patches[]objectPatches is a list of Kustomize patches
optionsmap[string]boolean
patchstring
pathstring
targetobject
annotationSelectorstring
groupstring
kindstring
labelSelectorstring
namestring
namespacestring
versionstring
replicas[]objectReplicas is a list of Kustomize Replicas override specifications
countobject requiredNumber of replicas
namestring requiredName of Deployment or StatefulSet
versionstringVersion controls which version of Kustomize to use for rendering manifests
namestringName is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
pathstringPath is a directory path within the Git repository, and is only valid for applications sourced from Git.
pluginobjectPlugin holds config management plugin specific options
env[]objectEnv is a list of environment variable entries
namestring requiredName is the name of the variable, usually expressed in uppercase
valuestring requiredValue is the value of the variable
namestring
parameters[]object
array[]stringArray is the value of an array type parameter.
mapmap[string]stringMap is the value of a map type parameter.
namestringName is the name identifying a parameter.
stringstringString_ is the value of a string type parameter.
refstringRef is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURLstring requiredRepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevisionstringTargetRevision 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.
sourceHydratorobjectSourceHydrator provides a way to push hydrated manifests back to git before syncing them to the cluster.
drySourceobject requiredDrySource specifies where the dry "don't repeat yourself" manifest source lives.
directoryobjectDirectory specifies path/directory specific options
excludestringExclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
includestringInclude contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnetobjectJsonnet holds options specific to Jsonnet
extVars[]objectExtVars is a list of Jsonnet External Variables
codeboolean
namestring required
valuestring required
libs[]stringAdditional library search dirs
tlas[]objectTLAS is a list of Jsonnet Top-level Arguments
codeboolean
namestring required
valuestring required
recursebooleanRecurse specifies whether to scan a directory recursively for manifests
helmobjectHelm specifies helm specific options
apiVersions[]stringAPIVersions 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.
fileParameters[]objectFileParameters are file parameters to the helm template
namestringName is the name of the Helm parameter
pathstringPath is the path to the file containing the values for the Helm parameter
ignoreMissingValueFilesbooleanIgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersionstringKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
namespacestringNamespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters[]objectParameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceStringbooleanForceString determines whether to tell Helm to interpret booleans and numbers as strings
namestringName is the name of the Helm parameter
valuestringValue is the value for the Helm parameter
passCredentialsbooleanPassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseNamestringReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrdsbooleanSkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidationbooleanSkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTestsbooleanSkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles[]stringValuesFiles is a list of Helm value files to use when generating a template
valuesstringValues 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.
valuesObjectobjectValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
versionstringVersion is the Helm version to use for templating ("3")
kustomizeobjectKustomize specifies kustomize specific options
apiVersions[]stringAPIVersions 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.
commonAnnotationsmap[string]stringCommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubstbooleanCommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabelsmap[string]stringCommonLabels is a list of additional labels to add to rendered manifests
components[]stringComponents specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotationsbooleanForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabelsbooleanForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponentsbooleanIgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images[]stringImages is a list of Kustomize image override specifications
kubeVersionstringKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
labelIncludeTemplatesbooleanLabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelectorbooleanLabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefixstringNamePrefix overrides the namePrefix in the kustomization.yaml for Kustomize apps
nameSuffixstringNameSuffix overrides the nameSuffix in the kustomization.yaml for Kustomize apps
namespacestringNamespace sets the namespace that Kustomize adds to all resources
patches[]objectPatches is a list of Kustomize patches
optionsmap[string]boolean
patchstring
pathstring
targetobject
annotationSelectorstring
groupstring
kindstring
labelSelectorstring
namestring
namespacestring
versionstring
replicas[]objectReplicas is a list of Kustomize Replicas override specifications
countobject requiredNumber of replicas
namestring requiredName of Deployment or StatefulSet
versionstringVersion controls which version of Kustomize to use for rendering manifests
pathstring requiredPath is a directory path within the Git repository where the manifests are located
pluginobjectPlugin specifies config management plugin specific options
env[]objectEnv is a list of environment variable entries
namestring requiredName is the name of the variable, usually expressed in uppercase
valuestring requiredValue is the value of the variable
namestring
parameters[]object
array[]stringArray is the value of an array type parameter.
mapmap[string]stringMap is the value of a map type parameter.
namestringName is the name identifying a parameter.
stringstringString_ is the value of a string type parameter.
repoURLstring requiredRepoURL is the URL to the git repository that contains the application manifests
targetRevisionstring requiredTargetRevision defines the revision of the source to hydrate
hydrateToobjectHydrateTo 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.
targetBranchstring requiredTargetBranch is the branch to which hydrated manifests should be committed
syncSourceobject requiredSyncSource specifies where to sync hydrated manifests from.
pathstring requiredPath 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.
targetBranchstring requiredTargetBranch 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.
syncPolicyobjectSyncPolicy controls when and how a sync will be performed
automatedobjectAutomated will keep an application synced to the target revision
allowEmptybooleanAllowEmpty allows apps have zero live resources (default: false)
enabledbooleanEnable allows apps to explicitly control automated sync
prunebooleanPrune specifies whether to delete resources from the cluster that are not found in the sources anymore as part of automated sync (default: false)
selfHealbooleanSelfHeal specifies whether to revert resources back to their desired state upon modification in the cluster (default: false)
managedNamespaceMetadataobjectManagedNamespaceMetadata controls metadata in the given namespace (if CreateNamespace=true)
annotationsmap[string]string
labelsmap[string]string
retryobjectRetry controls failed sync retry behavior
backoffobjectBackoff controls how to backoff on subsequent retries of failed syncs
durationstringDuration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")
factorinteger (int64)Factor is a factor to multiply the base duration after each failed retry
maxDurationstringMaxDuration is the maximum amount of time allowed for the backoff strategy
limitinteger (int64)Limit is the maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.
refreshbooleanRefresh indicates if the latest revision should be used on retry instead of the initial one (default: false)
syncOptions[]stringOptions allow you to specify whole app sync-options
statusobject read-onlyApplicationStatus contains status information for the application
conditions[]object read-onlyConditions is a list of currently observed application conditions
lastTransitionTimestring (date-time) read-onlyLastTransitionTime is the time the condition was last observed
messagestring required read-onlyMessage contains human-readable message indicating details about condition
typestring required read-onlyType is an application condition type
controllerNamespacestring read-onlyControllerNamespace indicates the namespace in which the application controller is located
healthobject read-onlyHealth contains information about the application's current health status
lastTransitionTimestring (date-time) read-onlyLastTransitionTime is the time the HealthStatus was set or updated
messagestring read-onlyMessage is a human-readable informational message describing the health statusDeprecated: this field is not used and will be removed in a future release.
statusstring read-onlyStatus holds the status code of the application
history[]object read-onlyHistory contains information about the application's sync history
deployStartedAtstring (date-time) read-onlyDeployStartedAt holds the time the sync operation started
deployedAtstring (date-time) required read-onlyDeployedAt holds the time the sync operation completed
idinteger (int64) required read-onlyID is an auto incrementing identifier of the RevisionHistory
initiatedByobject read-onlyInitiatedBy contains information about who initiated the operations
automatedboolean read-onlyAutomated is set to true if operation was initiated automatically by the application controller.
usernamestring read-onlyUsername contains the name of a user who started operation
revisionstring or revisions read-onlyRevision holds the revision the sync was performed against
sourceobject or sources read-onlySource is a reference to the application source used for the sync operation
chartstring read-onlyChart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directoryobject read-onlyDirectory holds path/directory specific options
excludestring read-onlyExclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
includestring read-onlyInclude contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnetobject read-onlyJsonnet holds options specific to Jsonnet
extVars[]object read-onlyExtVars is a list of Jsonnet External Variables
codeboolean read-only
namestring required read-only
valuestring required read-only
libs[]string read-onlyAdditional library search dirs
tlas[]object read-onlyTLAS is a list of Jsonnet Top-level Arguments
codeboolean read-only
namestring required read-only
valuestring required read-only
recurseboolean read-onlyRecurse specifies whether to scan a directory recursively for manifests
helmobject read-onlyHelm holds helm specific options
apiVersions[]string read-onlyAPIVersions 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.
fileParameters[]object read-onlyFileParameters are file parameters to the helm template
namestring read-onlyName is the name of the Helm parameter
pathstring read-onlyPath is the path to the file containing the values for the Helm parameter
ignoreMissingValueFilesboolean read-onlyIgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersionstring read-onlyKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
namespacestring read-onlyNamespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters[]object read-onlyParameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceStringboolean read-onlyForceString determines whether to tell Helm to interpret booleans and numbers as strings
namestring read-onlyName is the name of the Helm parameter
valuestring read-onlyValue is the value for the Helm parameter
passCredentialsboolean read-onlyPassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseNamestring read-onlyReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrdsboolean read-onlySkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidationboolean read-onlySkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTestsboolean read-onlySkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles[]string read-onlyValuesFiles is a list of Helm value files to use when generating a template
valuesstring read-onlyValues 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.
valuesObjectobject read-onlyValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
versionstring read-onlyVersion is the Helm version to use for templating ("3")
kustomizeobject read-onlyKustomize holds kustomize specific options
apiVersions[]string read-onlyAPIVersions 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.
commonAnnotationsmap[string]string read-onlyCommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubstboolean read-onlyCommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabelsmap[string]string read-onlyCommonLabels is a list of additional labels to add to rendered manifests
components[]string read-onlyComponents specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotationsboolean read-onlyForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabelsboolean read-onlyForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponentsboolean read-onlyIgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images[]string read-onlyImages is a list of Kustomize image override specifications
kubeVersionstring read-onlyKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
labelIncludeTemplatesboolean read-onlyLabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelectorboolean read-onlyLabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefixstring read-onlyNamePrefix overrides the namePrefix in the kustomization.yaml for Kustomize apps
nameSuffixstring read-onlyNameSuffix overrides the nameSuffix in the kustomization.yaml for Kustomize apps
namespacestring read-onlyNamespace sets the namespace that Kustomize adds to all resources
patches[]object read-onlyPatches is a list of Kustomize patches
optionsmap[string]boolean read-only
patchstring read-only
pathstring read-only
targetobject read-only
annotationSelectorstring read-only
groupstring read-only
kindstring read-only
labelSelectorstring read-only
namestring read-only
namespacestring read-only
versionstring read-only
replicas[]object read-onlyReplicas is a list of Kustomize Replicas override specifications
countobject required read-onlyNumber of replicas
namestring required read-onlyName of Deployment or StatefulSet
versionstring read-onlyVersion controls which version of Kustomize to use for rendering manifests
namestring read-onlyName is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
pathstring read-onlyPath is a directory path within the Git repository, and is only valid for applications sourced from Git.
pluginobject read-onlyPlugin holds config management plugin specific options
env[]object read-onlyEnv is a list of environment variable entries
namestring required read-onlyName is the name of the variable, usually expressed in uppercase
valuestring required read-onlyValue is the value of the variable
namestring read-only
parameters[]object read-only
array[]string read-onlyArray is the value of an array type parameter.
mapmap[string]string read-onlyMap is the value of a map type parameter.
namestring read-onlyName is the name identifying a parameter.
stringstring read-onlyString_ is the value of a string type parameter.
refstring read-onlyRef is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURLstring required read-onlyRepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevisionstring read-onlyTargetRevision 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.
observedAtstring (date-time) read-onlyObservedAt indicates when the application state was updated without querying latest git stateDeprecated: controller no longer updates ObservedAt field
operationStateobject read-onlyOperationState contains information about any ongoing operations, such as a sync
finishedAtstring (date-time) read-onlyFinishedAt contains time of operation completion
messagestring read-onlyMessage holds any pertinent messages when attempting to perform operation (typically errors).
operationobject required read-onlyOperation is the original requested operation
info[]object read-onlyInfo is a list of informational items for this operation
namestring required read-only
valuestring required read-only
initiatedByobject read-onlyInitiatedBy contains information about who initiated the operations
automatedboolean read-onlyAutomated is set to true if operation was initiated automatically by the application controller.
usernamestring read-onlyUsername contains the name of a user who started operation
retryobject read-onlyRetry controls the strategy to apply if a sync fails
backoffobject read-onlyBackoff controls how to backoff on subsequent retries of failed syncs
durationstring read-onlyDuration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")
factorinteger (int64) read-onlyFactor is a factor to multiply the base duration after each failed retry
maxDurationstring read-onlyMaxDuration is the maximum amount of time allowed for the backoff strategy
limitinteger (int64) read-onlyLimit is the maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.
refreshboolean read-onlyRefresh indicates if the latest revision should be used on retry instead of the initial one (default: false)
syncobject read-onlySync contains parameters for the operation
autoHealAttemptsCountinteger (int64) read-onlySelfHealAttemptsCount contains the number of auto-heal attempts
dryRunboolean read-onlyDryRun specifies to perform a `kubectl apply --dry-run` without actually performing the sync
manifests[]string read-onlyManifests is an optional field that overrides sync source with a local directory for development
pruneboolean read-onlyPrune specifies to delete resources from the cluster that are no longer tracked in git
resources[]object read-onlyResources describes which resources shall be part of the sync
groupstring read-only
kindstring required read-only
namestring required read-only
namespacestring read-only
revisionstring or revisions read-onlyRevision is the revision (Git) or chart version (Helm) which to sync the application to If omitted, will use the revision specified in app spec.
sourceobject or sources read-onlySource overrides the source definition set in the application. This is typically set in a Rollback operation and is nil during a Sync operation
chartstring read-onlyChart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directoryobject read-onlyDirectory holds path/directory specific options
excludestring read-onlyExclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
includestring read-onlyInclude contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnetobject read-onlyJsonnet holds options specific to Jsonnet
extVars[]object read-onlyExtVars is a list of Jsonnet External Variables
codeboolean read-only
namestring required read-only
valuestring required read-only
libs[]string read-onlyAdditional library search dirs
tlas[]object read-onlyTLAS is a list of Jsonnet Top-level Arguments
codeboolean read-only
namestring required read-only
valuestring required read-only
recurseboolean read-onlyRecurse specifies whether to scan a directory recursively for manifests
helmobject read-onlyHelm holds helm specific options
apiVersions[]string read-onlyAPIVersions 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.
fileParameters[]object read-onlyFileParameters are file parameters to the helm template
namestring read-onlyName is the name of the Helm parameter
pathstring read-onlyPath is the path to the file containing the values for the Helm parameter
ignoreMissingValueFilesboolean read-onlyIgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersionstring read-onlyKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
namespacestring read-onlyNamespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters[]object read-onlyParameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceStringboolean read-onlyForceString determines whether to tell Helm to interpret booleans and numbers as strings
namestring read-onlyName is the name of the Helm parameter
valuestring read-onlyValue is the value for the Helm parameter
passCredentialsboolean read-onlyPassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseNamestring read-onlyReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrdsboolean read-onlySkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidationboolean read-onlySkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTestsboolean read-onlySkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles[]string read-onlyValuesFiles is a list of Helm value files to use when generating a template
valuesstring read-onlyValues 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.
valuesObjectobject read-onlyValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
versionstring read-onlyVersion is the Helm version to use for templating ("3")
kustomizeobject read-onlyKustomize holds kustomize specific options
apiVersions[]string read-onlyAPIVersions 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.
commonAnnotationsmap[string]string read-onlyCommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubstboolean read-onlyCommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabelsmap[string]string read-onlyCommonLabels is a list of additional labels to add to rendered manifests
components[]string read-onlyComponents specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotationsboolean read-onlyForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabelsboolean read-onlyForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponentsboolean read-onlyIgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images[]string read-onlyImages is a list of Kustomize image override specifications
kubeVersionstring read-onlyKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
labelIncludeTemplatesboolean read-onlyLabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelectorboolean read-onlyLabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefixstring read-onlyNamePrefix overrides the namePrefix in the kustomization.yaml for Kustomize apps
nameSuffixstring read-onlyNameSuffix overrides the nameSuffix in the kustomization.yaml for Kustomize apps
namespacestring read-onlyNamespace sets the namespace that Kustomize adds to all resources
patches[]object read-onlyPatches is a list of Kustomize patches
optionsmap[string]boolean read-only
patchstring read-only
pathstring read-only
targetobject read-only
annotationSelectorstring read-only
groupstring read-only
kindstring read-only
labelSelectorstring read-only
namestring read-only
namespacestring read-only
versionstring read-only
replicas[]object read-onlyReplicas is a list of Kustomize Replicas override specifications
countobject required read-onlyNumber of replicas
namestring required read-onlyName of Deployment or StatefulSet
versionstring read-onlyVersion controls which version of Kustomize to use for rendering manifests
namestring read-onlyName is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
pathstring read-onlyPath is a directory path within the Git repository, and is only valid for applications sourced from Git.
pluginobject read-onlyPlugin holds config management plugin specific options
env[]object read-onlyEnv is a list of environment variable entries
namestring required read-onlyName is the name of the variable, usually expressed in uppercase
valuestring required read-onlyValue is the value of the variable
namestring read-only
parameters[]object read-only
array[]string read-onlyArray is the value of an array type parameter.
mapmap[string]string read-onlyMap is the value of a map type parameter.
namestring read-onlyName is the name identifying a parameter.
stringstring read-onlyString_ is the value of a string type parameter.
refstring read-onlyRef is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURLstring required read-onlyRepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevisionstring read-onlyTargetRevision 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.
syncOptions[]string read-onlySyncOptions provide per-sync sync-options, e.g. Validate=false
syncStrategyobject read-onlySyncStrategy describes how to perform the sync
applyobject read-onlyApply will perform a `kubectl apply` to perform the sync.
forceboolean read-onlyForce 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.
hookobject read-onlyHook will submit any referenced resources to perform the sync. This is the default strategy
forceboolean read-onlyForce 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.
phasestring required read-onlyPhase is the current phase of the operation
retryCountinteger (int64) read-onlyRetryCount contains time of operation retries
startedAtstring (date-time) required read-onlyStartedAt contains time of operation start
syncResultobject read-onlySyncResult is the result of a Sync operation
managedNamespaceMetadataobject read-onlyManagedNamespaceMetadata contains the current sync state of managed namespace metadata
annotationsmap[string]string read-only
labelsmap[string]string read-only
resources[]object read-onlyResources contains a list of sync result items for each individual resource in a sync operation
groupstring required read-onlyGroup specifies the API group of the resource
hookPhasestring read-onlyHookPhase contains the state of any operation associated with this resource OR hook This can also contain values for non-hook resources.
hookTypestring read-onlyHookType specifies the type of the hook. Empty for non-hook resources
images[]string read-onlyImages contains the images related to the ResourceResult
kindstring required read-onlyKind specifies the API kind of the resource
messagestring read-onlyMessage contains an informational or error message for the last sync OR operation
namestring required read-onlyName specifies the name of the resource
namespacestring required read-onlyNamespace specifies the target namespace of the resource
statusstring read-onlyStatus 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
syncPhasestring read-onlySyncPhase indicates the particular phase of the sync that this result was acquired in
versionstring required read-onlyVersion specifies the API version of the resource
revisionstring or revisions required read-onlyRevision holds the revision this sync operation was performed to
sourceobject or sources read-onlySource records the application source information of the sync, used for comparing auto-sync
chartstring read-onlyChart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directoryobject read-onlyDirectory holds path/directory specific options
excludestring read-onlyExclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
includestring read-onlyInclude contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnetobject read-onlyJsonnet holds options specific to Jsonnet
extVars[]object read-onlyExtVars is a list of Jsonnet External Variables
codeboolean read-only
namestring required read-only
valuestring required read-only
libs[]string read-onlyAdditional library search dirs
tlas[]object read-onlyTLAS is a list of Jsonnet Top-level Arguments
codeboolean read-only
namestring required read-only
valuestring required read-only
recurseboolean read-onlyRecurse specifies whether to scan a directory recursively for manifests
helmobject read-onlyHelm holds helm specific options
apiVersions[]string read-onlyAPIVersions 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.
fileParameters[]object read-onlyFileParameters are file parameters to the helm template
namestring read-onlyName is the name of the Helm parameter
pathstring read-onlyPath is the path to the file containing the values for the Helm parameter
ignoreMissingValueFilesboolean read-onlyIgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersionstring read-onlyKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
namespacestring read-onlyNamespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters[]object read-onlyParameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceStringboolean read-onlyForceString determines whether to tell Helm to interpret booleans and numbers as strings
namestring read-onlyName is the name of the Helm parameter
valuestring read-onlyValue is the value for the Helm parameter
passCredentialsboolean read-onlyPassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseNamestring read-onlyReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrdsboolean read-onlySkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidationboolean read-onlySkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTestsboolean read-onlySkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles[]string read-onlyValuesFiles is a list of Helm value files to use when generating a template
valuesstring read-onlyValues 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.
valuesObjectobject read-onlyValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
versionstring read-onlyVersion is the Helm version to use for templating ("3")
kustomizeobject read-onlyKustomize holds kustomize specific options
apiVersions[]string read-onlyAPIVersions 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.
commonAnnotationsmap[string]string read-onlyCommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubstboolean read-onlyCommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabelsmap[string]string read-onlyCommonLabels is a list of additional labels to add to rendered manifests
components[]string read-onlyComponents specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotationsboolean read-onlyForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabelsboolean read-onlyForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponentsboolean read-onlyIgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images[]string read-onlyImages is a list of Kustomize image override specifications
kubeVersionstring read-onlyKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
labelIncludeTemplatesboolean read-onlyLabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelectorboolean read-onlyLabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefixstring read-onlyNamePrefix overrides the namePrefix in the kustomization.yaml for Kustomize apps
nameSuffixstring read-onlyNameSuffix overrides the nameSuffix in the kustomization.yaml for Kustomize apps
namespacestring read-onlyNamespace sets the namespace that Kustomize adds to all resources
patches[]object read-onlyPatches is a list of Kustomize patches
optionsmap[string]boolean read-only
patchstring read-only
pathstring read-only
targetobject read-only
annotationSelectorstring read-only
groupstring read-only
kindstring read-only
labelSelectorstring read-only
namestring read-only
namespacestring read-only
versionstring read-only
replicas[]object read-onlyReplicas is a list of Kustomize Replicas override specifications
countobject required read-onlyNumber of replicas
namestring required read-onlyName of Deployment or StatefulSet
versionstring read-onlyVersion controls which version of Kustomize to use for rendering manifests
namestring read-onlyName is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
pathstring read-onlyPath is a directory path within the Git repository, and is only valid for applications sourced from Git.
pluginobject read-onlyPlugin holds config management plugin specific options
env[]object read-onlyEnv is a list of environment variable entries
namestring required read-onlyName is the name of the variable, usually expressed in uppercase
valuestring required read-onlyValue is the value of the variable
namestring read-only
parameters[]object read-only
array[]string read-onlyArray is the value of an array type parameter.
mapmap[string]string read-onlyMap is the value of a map type parameter.
namestring read-onlyName is the name identifying a parameter.
stringstring read-onlyString_ is the value of a string type parameter.
refstring read-onlyRef is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURLstring required read-onlyRepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevisionstring read-onlyTargetRevision 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.
reconciledAtstring (date-time) read-onlyReconciledAt indicates when the application state was reconciled using the latest git version
resourceHealthSourcestring read-onlyResourceHealthSource indicates where the resource health status is stored: inline if not set or appTree
resources[]object read-onlyResources is a list of Kubernetes resources managed by this application
groupstring read-onlyGroup represents the API group of the resource (e.g., "apps" for Deployments).
healthobject read-onlyHealth indicates the health status of the resource (e.g., Healthy, Degraded, Progressing).
lastTransitionTimestring (date-time) read-onlyLastTransitionTime is the time the HealthStatus was set or updatedDeprecated: this field is not used and will be removed in a future release.
messagestring read-onlyMessage is a human-readable informational message describing the health status
statusstring read-onlyStatus holds the status code of the resource
hookboolean read-onlyHook is true if the resource is used as a lifecycle hook in an Argo CD application.
kindstring read-onlyKind specifies the type of the resource (e.g., "Deployment", "Service").
namestring read-onlyName is the unique name of the resource within the namespace.
namespacestring read-onlyNamespace defines the Kubernetes namespace where the resource is located.
requiresDeletionConfirmationboolean read-onlyRequiresDeletionConfirmation is true if the resource requires explicit user confirmation before deletion.
requiresPruningboolean read-onlyRequiresPruning is true if the resource needs to be pruned (deleted) as part of synchronization.
statusstring read-onlyStatus represents the synchronization state of the resource (e.g., Synced, OutOfSync).
syncWaveinteger (int64) read-onlySyncWave determines the order in which resources are applied during a sync operation. Lower values are applied first.
versionstring read-onlyVersion indicates the API version of the resource (e.g., "v1", "v1beta1").
sourceHydratorobject read-onlySourceHydrator stores information about the current state of source hydration
currentOperationobject read-onlyCurrentOperation holds the status of the hydrate operation
drySHAstring read-onlyDrySHA holds the resolved revision (sha) of the dry source as of the most recent reconciliation
finishedAtstring (date-time) read-onlyFinishedAt indicates when the hydrate operation finished
hydratedSHAstring read-onlyHydratedSHA holds the resolved revision (sha) of the hydrated source as of the most recent reconciliation
messagestring required read-onlyMessage contains a message describing the current status of the hydrate operation
phasestring required read-onlyPhase indicates the status of the hydrate operation
sourceHydratorobject read-onlySourceHydrator holds the hydrator config used for the hydrate operation
drySourceobject required read-onlyDrySource specifies where the dry "don't repeat yourself" manifest source lives.
directoryobject read-onlyDirectory specifies path/directory specific options
excludestring read-onlyExclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
includestring read-onlyInclude contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnetobject read-onlyJsonnet holds options specific to Jsonnet
extVars[]object read-onlyExtVars is a list of Jsonnet External Variables
codeboolean read-only
namestring required read-only
valuestring required read-only
libs[]string read-onlyAdditional library search dirs
tlas[]object read-onlyTLAS is a list of Jsonnet Top-level Arguments
codeboolean read-only
namestring required read-only
valuestring required read-only
recurseboolean read-onlyRecurse specifies whether to scan a directory recursively for manifests
helmobject read-onlyHelm specifies helm specific options
apiVersions[]string read-onlyAPIVersions 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.
fileParameters[]object read-onlyFileParameters are file parameters to the helm template
namestring read-onlyName is the name of the Helm parameter
pathstring read-onlyPath is the path to the file containing the values for the Helm parameter
ignoreMissingValueFilesboolean read-onlyIgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersionstring read-onlyKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
namespacestring read-onlyNamespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters[]object read-onlyParameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceStringboolean read-onlyForceString determines whether to tell Helm to interpret booleans and numbers as strings
namestring read-onlyName is the name of the Helm parameter
valuestring read-onlyValue is the value for the Helm parameter
passCredentialsboolean read-onlyPassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseNamestring read-onlyReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrdsboolean read-onlySkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidationboolean read-onlySkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTestsboolean read-onlySkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles[]string read-onlyValuesFiles is a list of Helm value files to use when generating a template
valuesstring read-onlyValues 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.
valuesObjectobject read-onlyValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
versionstring read-onlyVersion is the Helm version to use for templating ("3")
kustomizeobject read-onlyKustomize specifies kustomize specific options
apiVersions[]string read-onlyAPIVersions 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.
commonAnnotationsmap[string]string read-onlyCommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubstboolean read-onlyCommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabelsmap[string]string read-onlyCommonLabels is a list of additional labels to add to rendered manifests
components[]string read-onlyComponents specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotationsboolean read-onlyForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabelsboolean read-onlyForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponentsboolean read-onlyIgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images[]string read-onlyImages is a list of Kustomize image override specifications
kubeVersionstring read-onlyKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
labelIncludeTemplatesboolean read-onlyLabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelectorboolean read-onlyLabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefixstring read-onlyNamePrefix overrides the namePrefix in the kustomization.yaml for Kustomize apps
nameSuffixstring read-onlyNameSuffix overrides the nameSuffix in the kustomization.yaml for Kustomize apps
namespacestring read-onlyNamespace sets the namespace that Kustomize adds to all resources
patches[]object read-onlyPatches is a list of Kustomize patches
optionsmap[string]boolean read-only
patchstring read-only
pathstring read-only
targetobject read-only
annotationSelectorstring read-only
groupstring read-only
kindstring read-only
labelSelectorstring read-only
namestring read-only
namespacestring read-only
versionstring read-only
replicas[]object read-onlyReplicas is a list of Kustomize Replicas override specifications
countobject required read-onlyNumber of replicas
namestring required read-onlyName of Deployment or StatefulSet
versionstring read-onlyVersion controls which version of Kustomize to use for rendering manifests
pathstring required read-onlyPath is a directory path within the Git repository where the manifests are located
pluginobject read-onlyPlugin specifies config management plugin specific options
env[]object read-onlyEnv is a list of environment variable entries
namestring required read-onlyName is the name of the variable, usually expressed in uppercase
valuestring required read-onlyValue is the value of the variable
namestring read-only
parameters[]object read-only
array[]string read-onlyArray is the value of an array type parameter.
mapmap[string]string read-onlyMap is the value of a map type parameter.
namestring read-onlyName is the name identifying a parameter.
stringstring read-onlyString_ is the value of a string type parameter.
repoURLstring required read-onlyRepoURL is the URL to the git repository that contains the application manifests
targetRevisionstring required read-onlyTargetRevision defines the revision of the source to hydrate
hydrateToobject read-onlyHydrateTo 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.
targetBranchstring required read-onlyTargetBranch is the branch to which hydrated manifests should be committed
syncSourceobject required read-onlySyncSource specifies where to sync hydrated manifests from.
pathstring required read-onlyPath 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.
targetBranchstring required read-onlyTargetBranch 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.
startedAtstring (date-time) read-onlyStartedAt indicates when the hydrate operation started
lastSuccessfulOperationobject read-onlyLastSuccessfulOperation holds info about the most recent successful hydration
drySHAstring read-onlyDrySHA holds the resolved revision (sha) of the dry source as of the most recent reconciliation
hydratedSHAstring read-onlyHydratedSHA holds the resolved revision (sha) of the hydrated source as of the most recent reconciliation
sourceHydratorobject read-onlySourceHydrator holds the hydrator config used for the hydrate operation
drySourceobject required read-onlyDrySource specifies where the dry "don't repeat yourself" manifest source lives.
directoryobject read-onlyDirectory specifies path/directory specific options
excludestring read-onlyExclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
includestring read-onlyInclude contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnetobject read-onlyJsonnet holds options specific to Jsonnet
extVars[]object read-onlyExtVars is a list of Jsonnet External Variables
codeboolean read-only
namestring required read-only
valuestring required read-only
libs[]string read-onlyAdditional library search dirs
tlas[]object read-onlyTLAS is a list of Jsonnet Top-level Arguments
codeboolean read-only
namestring required read-only
valuestring required read-only
recurseboolean read-onlyRecurse specifies whether to scan a directory recursively for manifests
helmobject read-onlyHelm specifies helm specific options
apiVersions[]string read-onlyAPIVersions 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.
fileParameters[]object read-onlyFileParameters are file parameters to the helm template
namestring read-onlyName is the name of the Helm parameter
pathstring read-onlyPath is the path to the file containing the values for the Helm parameter
ignoreMissingValueFilesboolean read-onlyIgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersionstring read-onlyKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
namespacestring read-onlyNamespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters[]object read-onlyParameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceStringboolean read-onlyForceString determines whether to tell Helm to interpret booleans and numbers as strings
namestring read-onlyName is the name of the Helm parameter
valuestring read-onlyValue is the value for the Helm parameter
passCredentialsboolean read-onlyPassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseNamestring read-onlyReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrdsboolean read-onlySkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidationboolean read-onlySkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTestsboolean read-onlySkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles[]string read-onlyValuesFiles is a list of Helm value files to use when generating a template
valuesstring read-onlyValues 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.
valuesObjectobject read-onlyValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
versionstring read-onlyVersion is the Helm version to use for templating ("3")
kustomizeobject read-onlyKustomize specifies kustomize specific options
apiVersions[]string read-onlyAPIVersions 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.
commonAnnotationsmap[string]string read-onlyCommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubstboolean read-onlyCommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabelsmap[string]string read-onlyCommonLabels is a list of additional labels to add to rendered manifests
components[]string read-onlyComponents specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotationsboolean read-onlyForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabelsboolean read-onlyForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponentsboolean read-onlyIgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images[]string read-onlyImages is a list of Kustomize image override specifications
kubeVersionstring read-onlyKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
labelIncludeTemplatesboolean read-onlyLabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelectorboolean read-onlyLabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefixstring read-onlyNamePrefix overrides the namePrefix in the kustomization.yaml for Kustomize apps
nameSuffixstring read-onlyNameSuffix overrides the nameSuffix in the kustomization.yaml for Kustomize apps
namespacestring read-onlyNamespace sets the namespace that Kustomize adds to all resources
patches[]object read-onlyPatches is a list of Kustomize patches
optionsmap[string]boolean read-only
patchstring read-only
pathstring read-only
targetobject read-only
annotationSelectorstring read-only
groupstring read-only
kindstring read-only
labelSelectorstring read-only
namestring read-only
namespacestring read-only
versionstring read-only
replicas[]object read-onlyReplicas is a list of Kustomize Replicas override specifications
countobject required read-onlyNumber of replicas
namestring required read-onlyName of Deployment or StatefulSet
versionstring read-onlyVersion controls which version of Kustomize to use for rendering manifests
pathstring required read-onlyPath is a directory path within the Git repository where the manifests are located
pluginobject read-onlyPlugin specifies config management plugin specific options
env[]object read-onlyEnv is a list of environment variable entries
namestring required read-onlyName is the name of the variable, usually expressed in uppercase
valuestring required read-onlyValue is the value of the variable
namestring read-only
parameters[]object read-only
array[]string read-onlyArray is the value of an array type parameter.
mapmap[string]string read-onlyMap is the value of a map type parameter.
namestring read-onlyName is the name identifying a parameter.
stringstring read-onlyString_ is the value of a string type parameter.
repoURLstring required read-onlyRepoURL is the URL to the git repository that contains the application manifests
targetRevisionstring required read-onlyTargetRevision defines the revision of the source to hydrate
hydrateToobject read-onlyHydrateTo 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.
targetBranchstring required read-onlyTargetBranch is the branch to which hydrated manifests should be committed
syncSourceobject required read-onlySyncSource specifies where to sync hydrated manifests from.
pathstring required read-onlyPath 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.
targetBranchstring required read-onlyTargetBranch 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.
sourceTypestring or sourceTypes read-onlySourceType specifies the type of this application
summaryobject read-onlySummary contains a list of URLs and container images used by this application
externalURLs[]string read-onlyExternalURLs holds all external URLs of application child resources.
images[]string read-onlyImages holds all images of application child resources.
syncobject read-onlySync contains information about the application's current sync status
comparedToobject read-onlyComparedTo contains information about what has been compared
destinationobject required read-onlyDestination is a reference to the application's destination used for comparison
namestring read-onlyName is an alternate way of specifying the target cluster by its symbolic name. This must be set if Server is not set.
namespacestring read-onlyNamespace 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
serverstring read-onlyServer specifies the URL of the target cluster's Kubernetes control plane API. This must be set if Name is not set.
ignoreDifferences[]object read-onlyIgnoreDifferences is a reference to the application's ignored differences used for comparison
groupstring read-only
jqPathExpressions[]string read-only
jsonPointers[]string read-only
kindstring required read-only
managedFieldsManagers[]string read-onlyManagedFieldsManagers 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
namestring read-only
namespacestring read-only
sourceobject or sources read-onlySource is a reference to the application's source used for comparison
chartstring read-onlyChart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directoryobject read-onlyDirectory holds path/directory specific options
excludestring read-onlyExclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
includestring read-onlyInclude contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnetobject read-onlyJsonnet holds options specific to Jsonnet
extVars[]object read-onlyExtVars is a list of Jsonnet External Variables
codeboolean read-only
namestring required read-only
valuestring required read-only
libs[]string read-onlyAdditional library search dirs
tlas[]object read-onlyTLAS is a list of Jsonnet Top-level Arguments
codeboolean read-only
namestring required read-only
valuestring required read-only
recurseboolean read-onlyRecurse specifies whether to scan a directory recursively for manifests
helmobject read-onlyHelm holds helm specific options
apiVersions[]string read-onlyAPIVersions 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.
fileParameters[]object read-onlyFileParameters are file parameters to the helm template
namestring read-onlyName is the name of the Helm parameter
pathstring read-onlyPath is the path to the file containing the values for the Helm parameter
ignoreMissingValueFilesboolean read-onlyIgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersionstring read-onlyKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
namespacestring read-onlyNamespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters[]object read-onlyParameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceStringboolean read-onlyForceString determines whether to tell Helm to interpret booleans and numbers as strings
namestring read-onlyName is the name of the Helm parameter
valuestring read-onlyValue is the value for the Helm parameter
passCredentialsboolean read-onlyPassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseNamestring read-onlyReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrdsboolean read-onlySkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidationboolean read-onlySkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTestsboolean read-onlySkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles[]string read-onlyValuesFiles is a list of Helm value files to use when generating a template
valuesstring read-onlyValues 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.
valuesObjectobject read-onlyValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
versionstring read-onlyVersion is the Helm version to use for templating ("3")
kustomizeobject read-onlyKustomize holds kustomize specific options
apiVersions[]string read-onlyAPIVersions 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.
commonAnnotationsmap[string]string read-onlyCommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubstboolean read-onlyCommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabelsmap[string]string read-onlyCommonLabels is a list of additional labels to add to rendered manifests
components[]string read-onlyComponents specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotationsboolean read-onlyForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabelsboolean read-onlyForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponentsboolean read-onlyIgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images[]string read-onlyImages is a list of Kustomize image override specifications
kubeVersionstring read-onlyKubeVersion specifies the Kubernetes API version to pass to Helm when templating manifests. By default, Argo CD uses the Kubernetes version of the target cluster.
labelIncludeTemplatesboolean read-onlyLabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelectorboolean read-onlyLabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefixstring read-onlyNamePrefix overrides the namePrefix in the kustomization.yaml for Kustomize apps
nameSuffixstring read-onlyNameSuffix overrides the nameSuffix in the kustomization.yaml for Kustomize apps
namespacestring read-onlyNamespace sets the namespace that Kustomize adds to all resources
patches[]object read-onlyPatches is a list of Kustomize patches
optionsmap[string]boolean read-only
patchstring read-only
pathstring read-only
targetobject read-only
annotationSelectorstring read-only
groupstring read-only
kindstring read-only
labelSelectorstring read-only
namestring read-only
namespacestring read-only
versionstring read-only
replicas[]object read-onlyReplicas is a list of Kustomize Replicas override specifications
countobject required read-onlyNumber of replicas
namestring required read-onlyName of Deployment or StatefulSet
versionstring read-onlyVersion controls which version of Kustomize to use for rendering manifests
namestring read-onlyName is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
pathstring read-onlyPath is a directory path within the Git repository, and is only valid for applications sourced from Git.
pluginobject read-onlyPlugin holds config management plugin specific options
env[]object read-onlyEnv is a list of environment variable entries
namestring required read-onlyName is the name of the variable, usually expressed in uppercase
valuestring required read-onlyValue is the value of the variable
namestring read-only
parameters[]object read-only
array[]string read-onlyArray is the value of an array type parameter.
mapmap[string]string read-onlyMap is the value of a map type parameter.
namestring read-onlyName is the name identifying a parameter.
stringstring read-onlyString_ is the value of a string type parameter.
refstring read-onlyRef is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURLstring required read-onlyRepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevisionstring read-onlyTargetRevision 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.
revisionstring or revisions read-onlyRevision contains information about the revision the comparison has been performed to
statusstring required read-onlyStatus is the sync state of the comparison