← Back to index Esc
Kind
Application
Group
argoproj.io
Version
v1alpha1
apiVersion: argoproj.io/v1alpha1 kind: Application metadata: name: example
View raw schema
apiVersion 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
kind 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
metadata object required
operation object
Operation contains information about a requested or running operation
info []object
Info is a list of informational items for this operation
name string required
value string required
initiatedBy object
InitiatedBy contains information about who initiated the operations
automated boolean
Automated is set to true if operation was initiated automatically by the application controller.
username string
Username contains the name of a user who started operation
retry object
Retry controls the strategy to apply if a sync fails
backoff object
Backoff controls how to backoff on subsequent retries of failed syncs
duration string
Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")
factor integer
Factor is a factor to multiply the base duration after each failed retry
format: int64
maxDuration string
MaxDuration is the maximum amount of time allowed for the backoff strategy
limit integer
Limit is the maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.
format: int64
refresh boolean
Refresh indicates if the latest revision should be used on retry instead of the initial one (default: false)
sync object
Sync contains parameters for the operation
autoHealAttemptsCount integer
SelfHealAttemptsCount contains the number of auto-heal attempts
format: int64
dryRun boolean
DryRun specifies to perform a `kubectl apply --dry-run` without actually performing the sync
manifests []string
Manifests is an optional field that overrides sync source with a local directory for development
prune boolean
Prune specifies to delete resources from the cluster that are no longer tracked in git
resources []object
Resources describes which resources shall be part of the sync
group string
kind string required
name string required
namespace string
revision 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.
revisions []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.
source 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
chart string
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directory object
Directory holds path/directory specific options
exclude string
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
include string
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnet object
Jsonnet holds options specific to Jsonnet
extVars []object
ExtVars is a list of Jsonnet External Variables
code boolean
name string required
value string required
libs []string
Additional library search dirs
tlas []object
TLAS is a list of Jsonnet Top-level Arguments
code boolean
name string required
value string required
recurse boolean
Recurse specifies whether to scan a directory recursively for manifests
helm object
Helm holds helm specific options
apiVersions []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.
fileParameters []object
FileParameters are file parameters to the helm template
name string
Name is the name of the Helm parameter
path string
Path is the path to the file containing the values for the Helm parameter
ignoreMissingValueFiles boolean
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersion 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.
namespace string
Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters []object
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceString boolean
ForceString determines whether to tell Helm to interpret booleans and numbers as strings
name string
Name is the name of the Helm parameter
value string
Value is the value for the Helm parameter
passCredentials boolean
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseName string
ReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrds boolean
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidation boolean
SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTests boolean
SkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles []string
ValuesFiles is a list of Helm value files to use when generating a template
values 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.
valuesObject object
ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
version string
Version is the Helm version to use for templating ("3")
kustomize object
Kustomize holds kustomize specific options
apiVersions []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.
commonAnnotations object
CommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubst boolean
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabels object
CommonLabels is a list of additional labels to add to rendered manifests
components []string
Components specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotations boolean
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabels boolean
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponents boolean
IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images []string
Images is a list of Kustomize image override specifications
kubeVersion 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.
labelIncludeTemplates boolean
LabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelector boolean
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefix string
NamePrefix is a prefix appended to resources for Kustomize apps
nameSuffix string
NameSuffix is a suffix appended to resources for Kustomize apps
namespace string
Namespace sets the namespace that Kustomize adds to all resources
patches []object
Patches is a list of Kustomize patches
options object
patch string
path string
target object
annotationSelector string
group string
kind string
labelSelector string
name string
namespace string
version string
replicas []object
Replicas is a list of Kustomize Replicas override specifications
count object required
Number of replicas
name string required
Name of Deployment or StatefulSet
version string
Version controls which version of Kustomize to use for rendering manifests
name string
Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
path string
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
plugin object
Plugin holds config management plugin specific options
env []object
Env is a list of environment variable entries
name string required
Name is the name of the variable, usually expressed in uppercase
value string required
Value is the value of the variable
name string
parameters []object
array []string
Array is the value of an array type parameter.
map object
Map is the value of a map type parameter.
name string
Name is the name identifying a parameter.
string string
String_ is the value of a string type parameter.
ref string
Ref is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURL string required
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevision 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.
sources []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
chart string
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directory object
Directory holds path/directory specific options
exclude string
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
include string
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnet object
Jsonnet holds options specific to Jsonnet
extVars []object
ExtVars is a list of Jsonnet External Variables
code boolean
name string required
value string required
libs []string
Additional library search dirs
tlas []object
TLAS is a list of Jsonnet Top-level Arguments
code boolean
name string required
value string required
recurse boolean
Recurse specifies whether to scan a directory recursively for manifests
helm object
Helm holds helm specific options
apiVersions []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.
fileParameters []object
FileParameters are file parameters to the helm template
name string
Name is the name of the Helm parameter
path string
Path is the path to the file containing the values for the Helm parameter
ignoreMissingValueFiles boolean
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersion 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.
namespace string
Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters []object
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceString boolean
ForceString determines whether to tell Helm to interpret booleans and numbers as strings
name string
Name is the name of the Helm parameter
value string
Value is the value for the Helm parameter
passCredentials boolean
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseName string
ReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrds boolean
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidation boolean
SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTests boolean
SkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles []string
ValuesFiles is a list of Helm value files to use when generating a template
values 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.
valuesObject object
ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
version string
Version is the Helm version to use for templating ("3")
kustomize object
Kustomize holds kustomize specific options
apiVersions []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.
commonAnnotations object
CommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubst boolean
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabels object
CommonLabels is a list of additional labels to add to rendered manifests
components []string
Components specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotations boolean
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabels boolean
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponents boolean
IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images []string
Images is a list of Kustomize image override specifications
kubeVersion 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.
labelIncludeTemplates boolean
LabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelector boolean
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefix string
NamePrefix is a prefix appended to resources for Kustomize apps
nameSuffix string
NameSuffix is a suffix appended to resources for Kustomize apps
namespace string
Namespace sets the namespace that Kustomize adds to all resources
patches []object
Patches is a list of Kustomize patches
options object
patch string
path string
target object
annotationSelector string
group string
kind string
labelSelector string
name string
namespace string
version string
replicas []object
Replicas is a list of Kustomize Replicas override specifications
count object required
Number of replicas
name string required
Name of Deployment or StatefulSet
version string
Version controls which version of Kustomize to use for rendering manifests
name string
Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
path string
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
plugin object
Plugin holds config management plugin specific options
env []object
Env is a list of environment variable entries
name string required
Name is the name of the variable, usually expressed in uppercase
value string required
Value is the value of the variable
name string
parameters []object
array []string
Array is the value of an array type parameter.
map object
Map is the value of a map type parameter.
name string
Name is the name identifying a parameter.
string string
String_ is the value of a string type parameter.
ref string
Ref is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURL string required
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevision 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.
syncOptions []string
SyncOptions provide per-sync sync-options, e.g. Validate=false
syncStrategy object
SyncStrategy describes how to perform the sync
apply object
Apply will perform a `kubectl apply` to perform the sync.
force 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.
hook object
Hook will submit any referenced resources to perform the sync. This is the default strategy
force 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.
spec object required
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
destination object required
Destination is a reference to the target Kubernetes server and namespace
name string
Name is an alternate way of specifying the target cluster by its symbolic name. This must be set if Server is not set.
namespace 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
server string
Server specifies the URL of the target cluster's Kubernetes control plane API. This must be set if Name is not set.
ignoreDifferences []object
IgnoreDifferences is a list of resources and their fields which should be ignored during comparison
group string
jqPathExpressions []string
jsonPointers []string
kind string required
managedFieldsManagers []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
name string
namespace string
info []object
Info contains a list of information (URLs, email addresses, and plain text) that relates to the application
name string required
value string required
project string required
Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project.
revisionHistoryLimit integer
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.
format: int64
source object
Source is a reference to the location of the application's manifests or chart
chart string
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directory object
Directory holds path/directory specific options
exclude string
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
include string
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnet object
Jsonnet holds options specific to Jsonnet
extVars []object
ExtVars is a list of Jsonnet External Variables
code boolean
name string required
value string required
libs []string
Additional library search dirs
tlas []object
TLAS is a list of Jsonnet Top-level Arguments
code boolean
name string required
value string required
recurse boolean
Recurse specifies whether to scan a directory recursively for manifests
helm object
Helm holds helm specific options
apiVersions []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.
fileParameters []object
FileParameters are file parameters to the helm template
name string
Name is the name of the Helm parameter
path string
Path is the path to the file containing the values for the Helm parameter
ignoreMissingValueFiles boolean
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersion 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.
namespace string
Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters []object
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceString boolean
ForceString determines whether to tell Helm to interpret booleans and numbers as strings
name string
Name is the name of the Helm parameter
value string
Value is the value for the Helm parameter
passCredentials boolean
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseName string
ReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrds boolean
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidation boolean
SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTests boolean
SkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles []string
ValuesFiles is a list of Helm value files to use when generating a template
values 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.
valuesObject object
ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
version string
Version is the Helm version to use for templating ("3")
kustomize object
Kustomize holds kustomize specific options
apiVersions []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.
commonAnnotations object
CommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubst boolean
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabels object
CommonLabels is a list of additional labels to add to rendered manifests
components []string
Components specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotations boolean
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabels boolean
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponents boolean
IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images []string
Images is a list of Kustomize image override specifications
kubeVersion 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.
labelIncludeTemplates boolean
LabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelector boolean
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefix string
NamePrefix is a prefix appended to resources for Kustomize apps
nameSuffix string
NameSuffix is a suffix appended to resources for Kustomize apps
namespace string
Namespace sets the namespace that Kustomize adds to all resources
patches []object
Patches is a list of Kustomize patches
options object
patch string
path string
target object
annotationSelector string
group string
kind string
labelSelector string
name string
namespace string
version string
replicas []object
Replicas is a list of Kustomize Replicas override specifications
count object required
Number of replicas
name string required
Name of Deployment or StatefulSet
version string
Version controls which version of Kustomize to use for rendering manifests
name string
Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
path string
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
plugin object
Plugin holds config management plugin specific options
env []object
Env is a list of environment variable entries
name string required
Name is the name of the variable, usually expressed in uppercase
value string required
Value is the value of the variable
name string
parameters []object
array []string
Array is the value of an array type parameter.
map object
Map is the value of a map type parameter.
name string
Name is the name identifying a parameter.
string string
String_ is the value of a string type parameter.
ref string
Ref is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURL string required
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevision 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.
sourceHydrator object
SourceHydrator provides a way to push hydrated manifests back to git before syncing them to the cluster.
drySource object required
DrySource specifies where the dry "don't repeat yourself" manifest source lives.
directory object
Directory specifies path/directory specific options
exclude string
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
include string
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnet object
Jsonnet holds options specific to Jsonnet
extVars []object
ExtVars is a list of Jsonnet External Variables
code boolean
name string required
value string required
libs []string
Additional library search dirs
tlas []object
TLAS is a list of Jsonnet Top-level Arguments
code boolean
name string required
value string required
recurse boolean
Recurse specifies whether to scan a directory recursively for manifests
helm object
Helm specifies helm specific options
apiVersions []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.
fileParameters []object
FileParameters are file parameters to the helm template
name string
Name is the name of the Helm parameter
path string
Path is the path to the file containing the values for the Helm parameter
ignoreMissingValueFiles boolean
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersion 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.
namespace string
Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters []object
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceString boolean
ForceString determines whether to tell Helm to interpret booleans and numbers as strings
name string
Name is the name of the Helm parameter
value string
Value is the value for the Helm parameter
passCredentials boolean
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseName string
ReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrds boolean
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidation boolean
SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTests boolean
SkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles []string
ValuesFiles is a list of Helm value files to use when generating a template
values 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.
valuesObject object
ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
version string
Version is the Helm version to use for templating ("3")
kustomize object
Kustomize specifies kustomize specific options
apiVersions []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.
commonAnnotations object
CommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubst boolean
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabels object
CommonLabels is a list of additional labels to add to rendered manifests
components []string
Components specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotations boolean
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabels boolean
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponents boolean
IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images []string
Images is a list of Kustomize image override specifications
kubeVersion 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.
labelIncludeTemplates boolean
LabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelector boolean
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefix string
NamePrefix is a prefix appended to resources for Kustomize apps
nameSuffix string
NameSuffix is a suffix appended to resources for Kustomize apps
namespace string
Namespace sets the namespace that Kustomize adds to all resources
patches []object
Patches is a list of Kustomize patches
options object
patch string
path string
target object
annotationSelector string
group string
kind string
labelSelector string
name string
namespace string
version string
replicas []object
Replicas is a list of Kustomize Replicas override specifications
count object required
Number of replicas
name string required
Name of Deployment or StatefulSet
version string
Version controls which version of Kustomize to use for rendering manifests
path string required
Path is a directory path within the Git repository where the manifests are located
plugin object
Plugin specifies config management plugin specific options
env []object
Env is a list of environment variable entries
name string required
Name is the name of the variable, usually expressed in uppercase
value string required
Value is the value of the variable
name string
parameters []object
array []string
Array is the value of an array type parameter.
map object
Map is the value of a map type parameter.
name string
Name is the name identifying a parameter.
string string
String_ is the value of a string type parameter.
repoURL string required
RepoURL is the URL to the git repository that contains the application manifests
targetRevision string required
TargetRevision defines the revision of the source to hydrate
hydrateTo 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.
targetBranch string required
TargetBranch is the branch to which hydrated manifests should be committed
syncSource object required
SyncSource specifies where to sync hydrated manifests from.
path string required
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.
pattern: ^.{2,}|[^./]$
minLength: 1
targetBranch string required
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.
sources []object
Sources is a reference to the location of the application's manifests or chart
chart string
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directory object
Directory holds path/directory specific options
exclude string
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
include string
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnet object
Jsonnet holds options specific to Jsonnet
extVars []object
ExtVars is a list of Jsonnet External Variables
code boolean
name string required
value string required
libs []string
Additional library search dirs
tlas []object
TLAS is a list of Jsonnet Top-level Arguments
code boolean
name string required
value string required
recurse boolean
Recurse specifies whether to scan a directory recursively for manifests
helm object
Helm holds helm specific options
apiVersions []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.
fileParameters []object
FileParameters are file parameters to the helm template
name string
Name is the name of the Helm parameter
path string
Path is the path to the file containing the values for the Helm parameter
ignoreMissingValueFiles boolean
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersion 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.
namespace string
Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters []object
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceString boolean
ForceString determines whether to tell Helm to interpret booleans and numbers as strings
name string
Name is the name of the Helm parameter
value string
Value is the value for the Helm parameter
passCredentials boolean
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseName string
ReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrds boolean
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidation boolean
SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTests boolean
SkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles []string
ValuesFiles is a list of Helm value files to use when generating a template
values 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.
valuesObject object
ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
version string
Version is the Helm version to use for templating ("3")
kustomize object
Kustomize holds kustomize specific options
apiVersions []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.
commonAnnotations object
CommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubst boolean
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabels object
CommonLabels is a list of additional labels to add to rendered manifests
components []string
Components specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotations boolean
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabels boolean
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponents boolean
IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images []string
Images is a list of Kustomize image override specifications
kubeVersion 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.
labelIncludeTemplates boolean
LabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelector boolean
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefix string
NamePrefix is a prefix appended to resources for Kustomize apps
nameSuffix string
NameSuffix is a suffix appended to resources for Kustomize apps
namespace string
Namespace sets the namespace that Kustomize adds to all resources
patches []object
Patches is a list of Kustomize patches
options object
patch string
path string
target object
annotationSelector string
group string
kind string
labelSelector string
name string
namespace string
version string
replicas []object
Replicas is a list of Kustomize Replicas override specifications
count object required
Number of replicas
name string required
Name of Deployment or StatefulSet
version string
Version controls which version of Kustomize to use for rendering manifests
name string
Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
path string
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
plugin object
Plugin holds config management plugin specific options
env []object
Env is a list of environment variable entries
name string required
Name is the name of the variable, usually expressed in uppercase
value string required
Value is the value of the variable
name string
parameters []object
array []string
Array is the value of an array type parameter.
map object
Map is the value of a map type parameter.
name string
Name is the name identifying a parameter.
string string
String_ is the value of a string type parameter.
ref string
Ref is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURL string required
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevision 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.
syncPolicy object
SyncPolicy controls when and how a sync will be performed
automated object
Automated will keep an application synced to the target revision
allowEmpty boolean
AllowEmpty allows apps have zero live resources (default: false)
enabled boolean
Enable allows apps to explicitly control automated sync
prune 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)
selfHeal boolean
SelfHeal specifies whether to revert resources back to their desired state upon modification in the cluster (default: false)
managedNamespaceMetadata object
ManagedNamespaceMetadata controls metadata in the given namespace (if CreateNamespace=true)
annotations object
labels object
retry object
Retry controls failed sync retry behavior
backoff object
Backoff controls how to backoff on subsequent retries of failed syncs
duration string
Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")
factor integer
Factor is a factor to multiply the base duration after each failed retry
format: int64
maxDuration string
MaxDuration is the maximum amount of time allowed for the backoff strategy
limit integer
Limit is the maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.
format: int64
refresh boolean
Refresh indicates if the latest revision should be used on retry instead of the initial one (default: false)
syncOptions []string
Options allow you to specify whole app sync-options
status object
ApplicationStatus contains status information for the application
conditions []object
Conditions is a list of currently observed application conditions
lastTransitionTime string
LastTransitionTime is the time the condition was last observed
format: date-time
message string required
Message contains human-readable message indicating details about condition
type string required
Type is an application condition type
controllerNamespace string
ControllerNamespace indicates the namespace in which the application controller is located
health object
Health contains information about the application's current health status
lastTransitionTime string
LastTransitionTime is the time the HealthStatus was set or updated
format: date-time
message 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.
status string
Status holds the status code of the application
history []object
History contains information about the application's sync history
deployStartedAt string
DeployStartedAt holds the time the sync operation started
format: date-time
deployedAt string required
DeployedAt holds the time the sync operation completed
format: date-time
id integer required
ID is an auto incrementing identifier of the RevisionHistory
format: int64
initiatedBy object
InitiatedBy contains information about who initiated the operations
automated boolean
Automated is set to true if operation was initiated automatically by the application controller.
username string
Username contains the name of a user who started operation
revision string
Revision holds the revision the sync was performed against
revisions []string
Revisions holds the revision of each source in sources field the sync was performed against
source object
Source is a reference to the application source used for the sync operation
chart string
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directory object
Directory holds path/directory specific options
exclude string
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
include string
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnet object
Jsonnet holds options specific to Jsonnet
extVars []object
ExtVars is a list of Jsonnet External Variables
code boolean
name string required
value string required
libs []string
Additional library search dirs
tlas []object
TLAS is a list of Jsonnet Top-level Arguments
code boolean
name string required
value string required
recurse boolean
Recurse specifies whether to scan a directory recursively for manifests
helm object
Helm holds helm specific options
apiVersions []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.
fileParameters []object
FileParameters are file parameters to the helm template
name string
Name is the name of the Helm parameter
path string
Path is the path to the file containing the values for the Helm parameter
ignoreMissingValueFiles boolean
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersion 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.
namespace string
Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters []object
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceString boolean
ForceString determines whether to tell Helm to interpret booleans and numbers as strings
name string
Name is the name of the Helm parameter
value string
Value is the value for the Helm parameter
passCredentials boolean
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseName string
ReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrds boolean
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidation boolean
SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTests boolean
SkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles []string
ValuesFiles is a list of Helm value files to use when generating a template
values 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.
valuesObject object
ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
version string
Version is the Helm version to use for templating ("3")
kustomize object
Kustomize holds kustomize specific options
apiVersions []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.
commonAnnotations object
CommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubst boolean
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabels object
CommonLabels is a list of additional labels to add to rendered manifests
components []string
Components specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotations boolean
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabels boolean
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponents boolean
IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images []string
Images is a list of Kustomize image override specifications
kubeVersion 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.
labelIncludeTemplates boolean
LabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelector boolean
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefix string
NamePrefix is a prefix appended to resources for Kustomize apps
nameSuffix string
NameSuffix is a suffix appended to resources for Kustomize apps
namespace string
Namespace sets the namespace that Kustomize adds to all resources
patches []object
Patches is a list of Kustomize patches
options object
patch string
path string
target object
annotationSelector string
group string
kind string
labelSelector string
name string
namespace string
version string
replicas []object
Replicas is a list of Kustomize Replicas override specifications
count object required
Number of replicas
name string required
Name of Deployment or StatefulSet
version string
Version controls which version of Kustomize to use for rendering manifests
name string
Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
path string
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
plugin object
Plugin holds config management plugin specific options
env []object
Env is a list of environment variable entries
name string required
Name is the name of the variable, usually expressed in uppercase
value string required
Value is the value of the variable
name string
parameters []object
array []string
Array is the value of an array type parameter.
map object
Map is the value of a map type parameter.
name string
Name is the name identifying a parameter.
string string
String_ is the value of a string type parameter.
ref string
Ref is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURL string required
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevision 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.
sources []object
Sources is a reference to the application sources used for the sync operation
chart string
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directory object
Directory holds path/directory specific options
exclude string
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
include string
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnet object
Jsonnet holds options specific to Jsonnet
extVars []object
ExtVars is a list of Jsonnet External Variables
code boolean
name string required
value string required
libs []string
Additional library search dirs
tlas []object
TLAS is a list of Jsonnet Top-level Arguments
code boolean
name string required
value string required
recurse boolean
Recurse specifies whether to scan a directory recursively for manifests
helm object
Helm holds helm specific options
apiVersions []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.
fileParameters []object
FileParameters are file parameters to the helm template
name string
Name is the name of the Helm parameter
path string
Path is the path to the file containing the values for the Helm parameter
ignoreMissingValueFiles boolean
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersion 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.
namespace string
Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters []object
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceString boolean
ForceString determines whether to tell Helm to interpret booleans and numbers as strings
name string
Name is the name of the Helm parameter
value string
Value is the value for the Helm parameter
passCredentials boolean
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseName string
ReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrds boolean
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidation boolean
SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTests boolean
SkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles []string
ValuesFiles is a list of Helm value files to use when generating a template
values 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.
valuesObject object
ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
version string
Version is the Helm version to use for templating ("3")
kustomize object
Kustomize holds kustomize specific options
apiVersions []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.
commonAnnotations object
CommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubst boolean
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabels object
CommonLabels is a list of additional labels to add to rendered manifests
components []string
Components specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotations boolean
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabels boolean
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponents boolean
IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images []string
Images is a list of Kustomize image override specifications
kubeVersion 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.
labelIncludeTemplates boolean
LabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelector boolean
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefix string
NamePrefix is a prefix appended to resources for Kustomize apps
nameSuffix string
NameSuffix is a suffix appended to resources for Kustomize apps
namespace string
Namespace sets the namespace that Kustomize adds to all resources
patches []object
Patches is a list of Kustomize patches
options object
patch string
path string
target object
annotationSelector string
group string
kind string
labelSelector string
name string
namespace string
version string
replicas []object
Replicas is a list of Kustomize Replicas override specifications
count object required
Number of replicas
name string required
Name of Deployment or StatefulSet
version string
Version controls which version of Kustomize to use for rendering manifests
name string
Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
path string
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
plugin object
Plugin holds config management plugin specific options
env []object
Env is a list of environment variable entries
name string required
Name is the name of the variable, usually expressed in uppercase
value string required
Value is the value of the variable
name string
parameters []object
array []string
Array is the value of an array type parameter.
map object
Map is the value of a map type parameter.
name string
Name is the name identifying a parameter.
string string
String_ is the value of a string type parameter.
ref string
Ref is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURL string required
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevision 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.
observedAt string
ObservedAt indicates when the application state was updated without querying latest git state Deprecated: controller no longer updates ObservedAt field
format: date-time
operationState object
OperationState contains information about any ongoing operations, such as a sync
finishedAt string
FinishedAt contains time of operation completion
format: date-time
message string
Message holds any pertinent messages when attempting to perform operation (typically errors).
operation object required
Operation is the original requested operation
info []object
Info is a list of informational items for this operation
name string required
value string required
initiatedBy object
InitiatedBy contains information about who initiated the operations
automated boolean
Automated is set to true if operation was initiated automatically by the application controller.
username string
Username contains the name of a user who started operation
retry object
Retry controls the strategy to apply if a sync fails
backoff object
Backoff controls how to backoff on subsequent retries of failed syncs
duration string
Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")
factor integer
Factor is a factor to multiply the base duration after each failed retry
format: int64
maxDuration string
MaxDuration is the maximum amount of time allowed for the backoff strategy
limit integer
Limit is the maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.
format: int64
refresh boolean
Refresh indicates if the latest revision should be used on retry instead of the initial one (default: false)
sync object
Sync contains parameters for the operation
autoHealAttemptsCount integer
SelfHealAttemptsCount contains the number of auto-heal attempts
format: int64
dryRun boolean
DryRun specifies to perform a `kubectl apply --dry-run` without actually performing the sync
manifests []string
Manifests is an optional field that overrides sync source with a local directory for development
prune boolean
Prune specifies to delete resources from the cluster that are no longer tracked in git
resources []object
Resources describes which resources shall be part of the sync
group string
kind string required
name string required
namespace string
revision 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.
revisions []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.
source 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
chart string
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directory object
Directory holds path/directory specific options
exclude string
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
include string
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnet object
Jsonnet holds options specific to Jsonnet
extVars []object
ExtVars is a list of Jsonnet External Variables
code boolean
name string required
value string required
libs []string
Additional library search dirs
tlas []object
TLAS is a list of Jsonnet Top-level Arguments
code boolean
name string required
value string required
recurse boolean
Recurse specifies whether to scan a directory recursively for manifests
helm object
Helm holds helm specific options
apiVersions []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.
fileParameters []object
FileParameters are file parameters to the helm template
name string
Name is the name of the Helm parameter
path string
Path is the path to the file containing the values for the Helm parameter
ignoreMissingValueFiles boolean
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersion 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.
namespace string
Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters []object
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceString boolean
ForceString determines whether to tell Helm to interpret booleans and numbers as strings
name string
Name is the name of the Helm parameter
value string
Value is the value for the Helm parameter
passCredentials boolean
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseName string
ReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrds boolean
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidation boolean
SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTests boolean
SkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles []string
ValuesFiles is a list of Helm value files to use when generating a template
values 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.
valuesObject object
ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
version string
Version is the Helm version to use for templating ("3")
kustomize object
Kustomize holds kustomize specific options
apiVersions []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.
commonAnnotations object
CommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubst boolean
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabels object
CommonLabels is a list of additional labels to add to rendered manifests
components []string
Components specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotations boolean
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabels boolean
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponents boolean
IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images []string
Images is a list of Kustomize image override specifications
kubeVersion 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.
labelIncludeTemplates boolean
LabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelector boolean
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefix string
NamePrefix is a prefix appended to resources for Kustomize apps
nameSuffix string
NameSuffix is a suffix appended to resources for Kustomize apps
namespace string
Namespace sets the namespace that Kustomize adds to all resources
patches []object
Patches is a list of Kustomize patches
options object
patch string
path string
target object
annotationSelector string
group string
kind string
labelSelector string
name string
namespace string
version string
replicas []object
Replicas is a list of Kustomize Replicas override specifications
count object required
Number of replicas
name string required
Name of Deployment or StatefulSet
version string
Version controls which version of Kustomize to use for rendering manifests
name string
Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
path string
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
plugin object
Plugin holds config management plugin specific options
env []object
Env is a list of environment variable entries
name string required
Name is the name of the variable, usually expressed in uppercase
value string required
Value is the value of the variable
name string
parameters []object
array []string
Array is the value of an array type parameter.
map object
Map is the value of a map type parameter.
name string
Name is the name identifying a parameter.
string string
String_ is the value of a string type parameter.
ref string
Ref is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURL string required
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevision 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.
sources []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
chart string
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directory object
Directory holds path/directory specific options
exclude string
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
include string
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnet object
Jsonnet holds options specific to Jsonnet
extVars []object
ExtVars is a list of Jsonnet External Variables
code boolean
name string required
value string required
libs []string
Additional library search dirs
tlas []object
TLAS is a list of Jsonnet Top-level Arguments
code boolean
name string required
value string required
recurse boolean
Recurse specifies whether to scan a directory recursively for manifests
helm object
Helm holds helm specific options
apiVersions []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.
fileParameters []object
FileParameters are file parameters to the helm template
name string
Name is the name of the Helm parameter
path string
Path is the path to the file containing the values for the Helm parameter
ignoreMissingValueFiles boolean
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersion 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.
namespace string
Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters []object
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceString boolean
ForceString determines whether to tell Helm to interpret booleans and numbers as strings
name string
Name is the name of the Helm parameter
value string
Value is the value for the Helm parameter
passCredentials boolean
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseName string
ReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrds boolean
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidation boolean
SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTests boolean
SkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles []string
ValuesFiles is a list of Helm value files to use when generating a template
values 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.
valuesObject object
ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
version string
Version is the Helm version to use for templating ("3")
kustomize object
Kustomize holds kustomize specific options
apiVersions []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.
commonAnnotations object
CommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubst boolean
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabels object
CommonLabels is a list of additional labels to add to rendered manifests
components []string
Components specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotations boolean
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabels boolean
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponents boolean
IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images []string
Images is a list of Kustomize image override specifications
kubeVersion 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.
labelIncludeTemplates boolean
LabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelector boolean
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefix string
NamePrefix is a prefix appended to resources for Kustomize apps
nameSuffix string
NameSuffix is a suffix appended to resources for Kustomize apps
namespace string
Namespace sets the namespace that Kustomize adds to all resources
patches []object
Patches is a list of Kustomize patches
options object
patch string
path string
target object
annotationSelector string
group string
kind string
labelSelector string
name string
namespace string
version string
replicas []object
Replicas is a list of Kustomize Replicas override specifications
count object required
Number of replicas
name string required
Name of Deployment or StatefulSet
version string
Version controls which version of Kustomize to use for rendering manifests
name string
Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
path string
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
plugin object
Plugin holds config management plugin specific options
env []object
Env is a list of environment variable entries
name string required
Name is the name of the variable, usually expressed in uppercase
value string required
Value is the value of the variable
name string
parameters []object
array []string
Array is the value of an array type parameter.
map object
Map is the value of a map type parameter.
name string
Name is the name identifying a parameter.
string string
String_ is the value of a string type parameter.
ref string
Ref is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURL string required
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevision 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.
syncOptions []string
SyncOptions provide per-sync sync-options, e.g. Validate=false
syncStrategy object
SyncStrategy describes how to perform the sync
apply object
Apply will perform a `kubectl apply` to perform the sync.
force 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.
hook object
Hook will submit any referenced resources to perform the sync. This is the default strategy
force 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.
phase string required
Phase is the current phase of the operation
retryCount integer
RetryCount contains time of operation retries
format: int64
startedAt string required
StartedAt contains time of operation start
format: date-time
syncResult object
SyncResult is the result of a Sync operation
managedNamespaceMetadata object
ManagedNamespaceMetadata contains the current sync state of managed namespace metadata
annotations object
labels object
resources []object
Resources contains a list of sync result items for each individual resource in a sync operation
group string required
Group specifies the API group of the resource
hookPhase string
HookPhase contains the state of any operation associated with this resource OR hook This can also contain values for non-hook resources.
hookType string
HookType specifies the type of the hook. Empty for non-hook resources
images []string
Images contains the images related to the ResourceResult
kind string required
Kind specifies the API kind of the resource
message string
Message contains an informational or error message for the last sync OR operation
name string required
Name specifies the name of the resource
namespace string required
Namespace specifies the target namespace of the resource
status 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
syncPhase string
SyncPhase indicates the particular phase of the sync that this result was acquired in
version string required
Version specifies the API version of the resource
revision string required
Revision holds the revision this sync operation was performed to
revisions []string
Revisions holds the revision this sync operation was performed for respective indexed source in sources field
source object
Source records the application source information of the sync, used for comparing auto-sync
chart string
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directory object
Directory holds path/directory specific options
exclude string
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
include string
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnet object
Jsonnet holds options specific to Jsonnet
extVars []object
ExtVars is a list of Jsonnet External Variables
code boolean
name string required
value string required
libs []string
Additional library search dirs
tlas []object
TLAS is a list of Jsonnet Top-level Arguments
code boolean
name string required
value string required
recurse boolean
Recurse specifies whether to scan a directory recursively for manifests
helm object
Helm holds helm specific options
apiVersions []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.
fileParameters []object
FileParameters are file parameters to the helm template
name string
Name is the name of the Helm parameter
path string
Path is the path to the file containing the values for the Helm parameter
ignoreMissingValueFiles boolean
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersion 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.
namespace string
Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters []object
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceString boolean
ForceString determines whether to tell Helm to interpret booleans and numbers as strings
name string
Name is the name of the Helm parameter
value string
Value is the value for the Helm parameter
passCredentials boolean
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseName string
ReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrds boolean
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidation boolean
SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTests boolean
SkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles []string
ValuesFiles is a list of Helm value files to use when generating a template
values 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.
valuesObject object
ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
version string
Version is the Helm version to use for templating ("3")
kustomize object
Kustomize holds kustomize specific options
apiVersions []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.
commonAnnotations object
CommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubst boolean
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabels object
CommonLabels is a list of additional labels to add to rendered manifests
components []string
Components specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotations boolean
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabels boolean
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponents boolean
IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images []string
Images is a list of Kustomize image override specifications
kubeVersion 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.
labelIncludeTemplates boolean
LabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelector boolean
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefix string
NamePrefix is a prefix appended to resources for Kustomize apps
nameSuffix string
NameSuffix is a suffix appended to resources for Kustomize apps
namespace string
Namespace sets the namespace that Kustomize adds to all resources
patches []object
Patches is a list of Kustomize patches
options object
patch string
path string
target object
annotationSelector string
group string
kind string
labelSelector string
name string
namespace string
version string
replicas []object
Replicas is a list of Kustomize Replicas override specifications
count object required
Number of replicas
name string required
Name of Deployment or StatefulSet
version string
Version controls which version of Kustomize to use for rendering manifests
name string
Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
path string
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
plugin object
Plugin holds config management plugin specific options
env []object
Env is a list of environment variable entries
name string required
Name is the name of the variable, usually expressed in uppercase
value string required
Value is the value of the variable
name string
parameters []object
array []string
Array is the value of an array type parameter.
map object
Map is the value of a map type parameter.
name string
Name is the name identifying a parameter.
string string
String_ is the value of a string type parameter.
ref string
Ref is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURL string required
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevision 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.
sources []object
Source records the application source information of the sync, used for comparing auto-sync
chart string
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directory object
Directory holds path/directory specific options
exclude string
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
include string
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnet object
Jsonnet holds options specific to Jsonnet
extVars []object
ExtVars is a list of Jsonnet External Variables
code boolean
name string required
value string required
libs []string
Additional library search dirs
tlas []object
TLAS is a list of Jsonnet Top-level Arguments
code boolean
name string required
value string required
recurse boolean
Recurse specifies whether to scan a directory recursively for manifests
helm object
Helm holds helm specific options
apiVersions []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.
fileParameters []object
FileParameters are file parameters to the helm template
name string
Name is the name of the Helm parameter
path string
Path is the path to the file containing the values for the Helm parameter
ignoreMissingValueFiles boolean
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersion 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.
namespace string
Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters []object
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceString boolean
ForceString determines whether to tell Helm to interpret booleans and numbers as strings
name string
Name is the name of the Helm parameter
value string
Value is the value for the Helm parameter
passCredentials boolean
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseName string
ReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrds boolean
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidation boolean
SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTests boolean
SkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles []string
ValuesFiles is a list of Helm value files to use when generating a template
values 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.
valuesObject object
ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
version string
Version is the Helm version to use for templating ("3")
kustomize object
Kustomize holds kustomize specific options
apiVersions []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.
commonAnnotations object
CommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubst boolean
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabels object
CommonLabels is a list of additional labels to add to rendered manifests
components []string
Components specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotations boolean
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabels boolean
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponents boolean
IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images []string
Images is a list of Kustomize image override specifications
kubeVersion 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.
labelIncludeTemplates boolean
LabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelector boolean
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefix string
NamePrefix is a prefix appended to resources for Kustomize apps
nameSuffix string
NameSuffix is a suffix appended to resources for Kustomize apps
namespace string
Namespace sets the namespace that Kustomize adds to all resources
patches []object
Patches is a list of Kustomize patches
options object
patch string
path string
target object
annotationSelector string
group string
kind string
labelSelector string
name string
namespace string
version string
replicas []object
Replicas is a list of Kustomize Replicas override specifications
count object required
Number of replicas
name string required
Name of Deployment or StatefulSet
version string
Version controls which version of Kustomize to use for rendering manifests
name string
Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
path string
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
plugin object
Plugin holds config management plugin specific options
env []object
Env is a list of environment variable entries
name string required
Name is the name of the variable, usually expressed in uppercase
value string required
Value is the value of the variable
name string
parameters []object
array []string
Array is the value of an array type parameter.
map object
Map is the value of a map type parameter.
name string
Name is the name identifying a parameter.
string string
String_ is the value of a string type parameter.
ref string
Ref is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURL string required
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevision 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.
reconciledAt string
ReconciledAt indicates when the application state was reconciled using the latest git version
format: date-time
resourceHealthSource string
ResourceHealthSource indicates where the resource health status is stored: inline if not set or appTree
resources []object
Resources is a list of Kubernetes resources managed by this application
group string
Group represents the API group of the resource (e.g., "apps" for Deployments).
health object
Health indicates the health status of the resource (e.g., Healthy, Degraded, Progressing).
lastTransitionTime string
LastTransitionTime is the time the HealthStatus was set or updated Deprecated: this field is not used and will be removed in a future release.
format: date-time
message string
Message is a human-readable informational message describing the health status
status string
Status holds the status code of the resource
hook boolean
Hook is true if the resource is used as a lifecycle hook in an Argo CD application.
kind string
Kind specifies the type of the resource (e.g., "Deployment", "Service").
name string
Name is the unique name of the resource within the namespace.
namespace string
Namespace defines the Kubernetes namespace where the resource is located.
requiresDeletionConfirmation boolean
RequiresDeletionConfirmation is true if the resource requires explicit user confirmation before deletion.
requiresPruning boolean
RequiresPruning is true if the resource needs to be pruned (deleted) as part of synchronization.
status string
Status represents the synchronization state of the resource (e.g., Synced, OutOfSync).
syncWave integer
SyncWave determines the order in which resources are applied during a sync operation. Lower values are applied first.
format: int64
version string
Version indicates the API version of the resource (e.g., "v1", "v1beta1").
sourceHydrator object
SourceHydrator stores information about the current state of source hydration
currentOperation object
CurrentOperation holds the status of the hydrate operation
drySHA string
DrySHA holds the resolved revision (sha) of the dry source as of the most recent reconciliation
finishedAt string
FinishedAt indicates when the hydrate operation finished
format: date-time
hydratedSHA string
HydratedSHA holds the resolved revision (sha) of the hydrated source as of the most recent reconciliation
message string required
Message contains a message describing the current status of the hydrate operation
phase string required
Phase indicates the status of the hydrate operation
enum: Hydrating, Failed, Hydrated
sourceHydrator object
SourceHydrator holds the hydrator config used for the hydrate operation
drySource object required
DrySource specifies where the dry "don't repeat yourself" manifest source lives.
directory object
Directory specifies path/directory specific options
exclude string
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
include string
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnet object
Jsonnet holds options specific to Jsonnet
extVars []object
ExtVars is a list of Jsonnet External Variables
code boolean
name string required
value string required
libs []string
Additional library search dirs
tlas []object
TLAS is a list of Jsonnet Top-level Arguments
code boolean
name string required
value string required
recurse boolean
Recurse specifies whether to scan a directory recursively for manifests
helm object
Helm specifies helm specific options
apiVersions []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.
fileParameters []object
FileParameters are file parameters to the helm template
name string
Name is the name of the Helm parameter
path string
Path is the path to the file containing the values for the Helm parameter
ignoreMissingValueFiles boolean
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersion 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.
namespace string
Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters []object
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceString boolean
ForceString determines whether to tell Helm to interpret booleans and numbers as strings
name string
Name is the name of the Helm parameter
value string
Value is the value for the Helm parameter
passCredentials boolean
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseName string
ReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrds boolean
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidation boolean
SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTests boolean
SkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles []string
ValuesFiles is a list of Helm value files to use when generating a template
values 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.
valuesObject object
ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
version string
Version is the Helm version to use for templating ("3")
kustomize object
Kustomize specifies kustomize specific options
apiVersions []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.
commonAnnotations object
CommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubst boolean
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabels object
CommonLabels is a list of additional labels to add to rendered manifests
components []string
Components specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotations boolean
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabels boolean
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponents boolean
IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images []string
Images is a list of Kustomize image override specifications
kubeVersion 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.
labelIncludeTemplates boolean
LabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelector boolean
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefix string
NamePrefix is a prefix appended to resources for Kustomize apps
nameSuffix string
NameSuffix is a suffix appended to resources for Kustomize apps
namespace string
Namespace sets the namespace that Kustomize adds to all resources
patches []object
Patches is a list of Kustomize patches
options object
patch string
path string
target object
annotationSelector string
group string
kind string
labelSelector string
name string
namespace string
version string
replicas []object
Replicas is a list of Kustomize Replicas override specifications
count object required
Number of replicas
name string required
Name of Deployment or StatefulSet
version string
Version controls which version of Kustomize to use for rendering manifests
path string required
Path is a directory path within the Git repository where the manifests are located
plugin object
Plugin specifies config management plugin specific options
env []object
Env is a list of environment variable entries
name string required
Name is the name of the variable, usually expressed in uppercase
value string required
Value is the value of the variable
name string
parameters []object
array []string
Array is the value of an array type parameter.
map object
Map is the value of a map type parameter.
name string
Name is the name identifying a parameter.
string string
String_ is the value of a string type parameter.
repoURL string required
RepoURL is the URL to the git repository that contains the application manifests
targetRevision string required
TargetRevision defines the revision of the source to hydrate
hydrateTo 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.
targetBranch string required
TargetBranch is the branch to which hydrated manifests should be committed
syncSource object required
SyncSource specifies where to sync hydrated manifests from.
path string required
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.
pattern: ^.{2,}|[^./]$
minLength: 1
targetBranch string required
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.
startedAt string
StartedAt indicates when the hydrate operation started
format: date-time
lastSuccessfulOperation object
LastSuccessfulOperation holds info about the most recent successful hydration
drySHA string
DrySHA holds the resolved revision (sha) of the dry source as of the most recent reconciliation
hydratedSHA string
HydratedSHA holds the resolved revision (sha) of the hydrated source as of the most recent reconciliation
sourceHydrator object
SourceHydrator holds the hydrator config used for the hydrate operation
drySource object required
DrySource specifies where the dry "don't repeat yourself" manifest source lives.
directory object
Directory specifies path/directory specific options
exclude string
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
include string
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnet object
Jsonnet holds options specific to Jsonnet
extVars []object
ExtVars is a list of Jsonnet External Variables
code boolean
name string required
value string required
libs []string
Additional library search dirs
tlas []object
TLAS is a list of Jsonnet Top-level Arguments
code boolean
name string required
value string required
recurse boolean
Recurse specifies whether to scan a directory recursively for manifests
helm object
Helm specifies helm specific options
apiVersions []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.
fileParameters []object
FileParameters are file parameters to the helm template
name string
Name is the name of the Helm parameter
path string
Path is the path to the file containing the values for the Helm parameter
ignoreMissingValueFiles boolean
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersion 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.
namespace string
Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters []object
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceString boolean
ForceString determines whether to tell Helm to interpret booleans and numbers as strings
name string
Name is the name of the Helm parameter
value string
Value is the value for the Helm parameter
passCredentials boolean
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseName string
ReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrds boolean
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidation boolean
SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTests boolean
SkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles []string
ValuesFiles is a list of Helm value files to use when generating a template
values 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.
valuesObject object
ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
version string
Version is the Helm version to use for templating ("3")
kustomize object
Kustomize specifies kustomize specific options
apiVersions []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.
commonAnnotations object
CommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubst boolean
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabels object
CommonLabels is a list of additional labels to add to rendered manifests
components []string
Components specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotations boolean
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabels boolean
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponents boolean
IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images []string
Images is a list of Kustomize image override specifications
kubeVersion 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.
labelIncludeTemplates boolean
LabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelector boolean
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefix string
NamePrefix is a prefix appended to resources for Kustomize apps
nameSuffix string
NameSuffix is a suffix appended to resources for Kustomize apps
namespace string
Namespace sets the namespace that Kustomize adds to all resources
patches []object
Patches is a list of Kustomize patches
options object
patch string
path string
target object
annotationSelector string
group string
kind string
labelSelector string
name string
namespace string
version string
replicas []object
Replicas is a list of Kustomize Replicas override specifications
count object required
Number of replicas
name string required
Name of Deployment or StatefulSet
version string
Version controls which version of Kustomize to use for rendering manifests
path string required
Path is a directory path within the Git repository where the manifests are located
plugin object
Plugin specifies config management plugin specific options
env []object
Env is a list of environment variable entries
name string required
Name is the name of the variable, usually expressed in uppercase
value string required
Value is the value of the variable
name string
parameters []object
array []string
Array is the value of an array type parameter.
map object
Map is the value of a map type parameter.
name string
Name is the name identifying a parameter.
string string
String_ is the value of a string type parameter.
repoURL string required
RepoURL is the URL to the git repository that contains the application manifests
targetRevision string required
TargetRevision defines the revision of the source to hydrate
hydrateTo 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.
targetBranch string required
TargetBranch is the branch to which hydrated manifests should be committed
syncSource object required
SyncSource specifies where to sync hydrated manifests from.
path string required
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.
pattern: ^.{2,}|[^./]$
minLength: 1
targetBranch string required
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.
sourceType string
SourceType specifies the type of this application
sourceTypes []string
SourceTypes specifies the type of the sources included in the application
summary object
Summary contains a list of URLs and container images used by this application
externalURLs []string
ExternalURLs holds all external URLs of application child resources.
images []string
Images holds all images of application child resources.
sync object
Sync contains information about the application's current sync status
comparedTo object
ComparedTo contains information about what has been compared
destination object required
Destination is a reference to the application's destination used for comparison
name string
Name is an alternate way of specifying the target cluster by its symbolic name. This must be set if Server is not set.
namespace 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
server string
Server specifies the URL of the target cluster's Kubernetes control plane API. This must be set if Name is not set.
ignoreDifferences []object
IgnoreDifferences is a reference to the application's ignored differences used for comparison
group string
jqPathExpressions []string
jsonPointers []string
kind string required
managedFieldsManagers []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
name string
namespace string
source object
Source is a reference to the application's source used for comparison
chart string
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directory object
Directory holds path/directory specific options
exclude string
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
include string
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnet object
Jsonnet holds options specific to Jsonnet
extVars []object
ExtVars is a list of Jsonnet External Variables
code boolean
name string required
value string required
libs []string
Additional library search dirs
tlas []object
TLAS is a list of Jsonnet Top-level Arguments
code boolean
name string required
value string required
recurse boolean
Recurse specifies whether to scan a directory recursively for manifests
helm object
Helm holds helm specific options
apiVersions []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.
fileParameters []object
FileParameters are file parameters to the helm template
name string
Name is the name of the Helm parameter
path string
Path is the path to the file containing the values for the Helm parameter
ignoreMissingValueFiles boolean
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersion 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.
namespace string
Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters []object
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceString boolean
ForceString determines whether to tell Helm to interpret booleans and numbers as strings
name string
Name is the name of the Helm parameter
value string
Value is the value for the Helm parameter
passCredentials boolean
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseName string
ReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrds boolean
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidation boolean
SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTests boolean
SkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles []string
ValuesFiles is a list of Helm value files to use when generating a template
values 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.
valuesObject object
ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
version string
Version is the Helm version to use for templating ("3")
kustomize object
Kustomize holds kustomize specific options
apiVersions []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.
commonAnnotations object
CommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubst boolean
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabels object
CommonLabels is a list of additional labels to add to rendered manifests
components []string
Components specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotations boolean
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabels boolean
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponents boolean
IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images []string
Images is a list of Kustomize image override specifications
kubeVersion 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.
labelIncludeTemplates boolean
LabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelector boolean
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefix string
NamePrefix is a prefix appended to resources for Kustomize apps
nameSuffix string
NameSuffix is a suffix appended to resources for Kustomize apps
namespace string
Namespace sets the namespace that Kustomize adds to all resources
patches []object
Patches is a list of Kustomize patches
options object
patch string
path string
target object
annotationSelector string
group string
kind string
labelSelector string
name string
namespace string
version string
replicas []object
Replicas is a list of Kustomize Replicas override specifications
count object required
Number of replicas
name string required
Name of Deployment or StatefulSet
version string
Version controls which version of Kustomize to use for rendering manifests
name string
Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
path string
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
plugin object
Plugin holds config management plugin specific options
env []object
Env is a list of environment variable entries
name string required
Name is the name of the variable, usually expressed in uppercase
value string required
Value is the value of the variable
name string
parameters []object
array []string
Array is the value of an array type parameter.
map object
Map is the value of a map type parameter.
name string
Name is the name identifying a parameter.
string string
String_ is the value of a string type parameter.
ref string
Ref is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURL string required
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevision 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.
sources []object
Sources is a reference to the application's multiple sources used for comparison
chart string
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
directory object
Directory holds path/directory specific options
exclude string
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
include string
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
jsonnet object
Jsonnet holds options specific to Jsonnet
extVars []object
ExtVars is a list of Jsonnet External Variables
code boolean
name string required
value string required
libs []string
Additional library search dirs
tlas []object
TLAS is a list of Jsonnet Top-level Arguments
code boolean
name string required
value string required
recurse boolean
Recurse specifies whether to scan a directory recursively for manifests
helm object
Helm holds helm specific options
apiVersions []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.
fileParameters []object
FileParameters are file parameters to the helm template
name string
Name is the name of the Helm parameter
path string
Path is the path to the file containing the values for the Helm parameter
ignoreMissingValueFiles boolean
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
kubeVersion 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.
namespace string
Namespace is an optional namespace to template with. If left empty, defaults to the app's destination namespace.
parameters []object
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
forceString boolean
ForceString determines whether to tell Helm to interpret booleans and numbers as strings
name string
Name is the name of the Helm parameter
value string
Value is the value for the Helm parameter
passCredentials boolean
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
releaseName string
ReleaseName is the Helm release name to use. If omitted it will use the application name
skipCrds boolean
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
skipSchemaValidation boolean
SkipSchemaValidation skips JSON schema validation (Helm's --skip-schema-validation)
skipTests boolean
SkipTests skips test manifest installation step (Helm's --skip-tests).
valueFiles []string
ValuesFiles is a list of Helm value files to use when generating a template
values 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.
valuesObject object
ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
version string
Version is the Helm version to use for templating ("3")
kustomize object
Kustomize holds kustomize specific options
apiVersions []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.
commonAnnotations object
CommonAnnotations is a list of additional annotations to add to rendered manifests
commonAnnotationsEnvsubst boolean
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
commonLabels object
CommonLabels is a list of additional labels to add to rendered manifests
components []string
Components specifies a list of kustomize components to add to the kustomization before building
forceCommonAnnotations boolean
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
forceCommonLabels boolean
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
ignoreMissingComponents boolean
IgnoreMissingComponents prevents kustomize from failing when components do not exist locally by not appending them to kustomization file
images []string
Images is a list of Kustomize image override specifications
kubeVersion 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.
labelIncludeTemplates boolean
LabelIncludeTemplates specifies whether to apply common labels to resource templates or not
labelWithoutSelector boolean
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
namePrefix string
NamePrefix is a prefix appended to resources for Kustomize apps
nameSuffix string
NameSuffix is a suffix appended to resources for Kustomize apps
namespace string
Namespace sets the namespace that Kustomize adds to all resources
patches []object
Patches is a list of Kustomize patches
options object
patch string
path string
target object
annotationSelector string
group string
kind string
labelSelector string
name string
namespace string
version string
replicas []object
Replicas is a list of Kustomize Replicas override specifications
count object required
Number of replicas
name string required
Name of Deployment or StatefulSet
version string
Version controls which version of Kustomize to use for rendering manifests
name string
Name is used to refer to a source and is displayed in the UI. It is used in multi-source Applications.
path string
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
plugin object
Plugin holds config management plugin specific options
env []object
Env is a list of environment variable entries
name string required
Name is the name of the variable, usually expressed in uppercase
value string required
Value is the value of the variable
name string
parameters []object
array []string
Array is the value of an array type parameter.
map object
Map is the value of a map type parameter.
name string
Name is the name identifying a parameter.
string string
String_ is the value of a string type parameter.
ref string
Ref is reference to another source within sources field. This field will not be used if used with a `source` tag.
repoURL string required
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
targetRevision 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.
revision string
Revision contains information about the revision the comparison has been performed to
revisions []string
Revisions contains information about the revisions of multiple sources the comparison has been performed to
status string required
Status is the sync state of the comparison
Copied!