application.md

page_title	subcategory	description
argocd_application Data Source - terraform-provider-argocd		Reads an existing ArgoCD application.

argocd_application (Data Source)

Reads an existing ArgoCD application.

Example Usage

data "argocd_application" "foo" {
  metadata = {
    name      = "foo"
    namespace = "argocd"
  }
}

Schema

Required

• metadata (Attributes) Standard Kubernetes object metadata. For more info see the Kubernetes reference. (see below for nested schema)

Read-Only

• id (String) ArgoCD application identifier
• spec (Attributes) The application specification. (see below for nested schema)
• status (Attributes) Status information for the application. (see below for nested schema)

Nested Schema for metadata

Required:

• name (String) Name of the applications.argoproj.io, must be unique. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

Optional:

• namespace (String) Namespace of the applications.argoproj.io, must be unique. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

Read-Only:

• annotations (Map of String) An unstructured key value map stored with the cluster secret that may be used to store arbitrary metadata. More info: http://kubernetes.io/docs/user-guide/annotations
• generation (Number) A sequence number representing a specific generation of the desired state.
• labels (Map of String) Map of string keys and values that can be used to organize and categorize (scope and select) the cluster secret. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
• resource_version (String) An opaque value that represents the internal version of this applications.argoproj.io that can be used by clients to determine when applications.argoproj.io has changed. Read more: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
• uid (String) The unique in time and space value for this applications.argoproj.io. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

Nested Schema for spec

Read-Only:

• destination (Attributes) Reference to the Kubernetes server and namespace in which the application will be deployed. (see below for nested schema)
• ignore_differences (Attributes List) Resources and their fields which should be ignored during comparison. More info: https://argo-cd.readthedocs.io/en/stable/user-guide/diffing/#application-level-configuration. (see below for nested schema)
• infos (Attributes List) List of information (URLs, email addresses, and plain text) that relates to the application. (see below for nested schema)
• project (String) The project the application belongs to. Defaults to default.
• revision_history_limit (Number) 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.
• sources (Attributes List) Location of the application's manifests or chart. (see below for nested schema)
• sync_policy (Attributes) Controls when and how a sync will be performed. (see below for nested schema)

Nested Schema for spec.destination

Read-Only:

• name (String) Name of the target cluster. Can be used instead of server.
• namespace (String) 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) URL of the target cluster and must be set to the Kubernetes control plane API.

Nested Schema for spec.ignore_differences

Read-Only:

• group (String) The Kubernetes resource Group to match for.
• jq_path_expressions (Set of String) List of JQ path expression strings targeting the field(s) to ignore.
• json_pointers (Set of String) List of JSONPaths strings targeting the field(s) to ignore.
• kind (String) The Kubernetes resource Kind to match for.
• name (String) The Kubernetes resource Name to match for.
• namespace (String) The Kubernetes resource Namespace to match for.

Nested Schema for spec.infos

Read-Only:

• name (String) Name of the information.
• value (String) Value of the information.

Nested Schema for spec.sources

Read-Only:

• chart (String) Helm chart name. Must be specified for applications sourced from a Helm repo.
• directory (Attributes) Path/directory specific options. (see below for nested schema)
• helm (Attributes) Helm specific options. (see below for nested schema)
• kustomize (Attributes) Kustomize specific options. (see below for nested schema)
• path (String) Directory path within the repository. Only valid for applications sourced from Git.
• plugin (Attributes) Config management plugin specific options. (see below for nested schema)
• ref (String) Reference to another source within defined sources. See associated documentation on Helm value files from external Git repository regarding combining ref with path and/or chart.
• repo_url (String) URL to the repository (Git or Helm) that contains the application manifests.
• target_revision (String) 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.

Nested Schema for spec.sources.directory

Read-Only:

• exclude (String) Glob pattern to match paths against that should be explicitly excluded from being used during manifest generation. This takes precedence over the include field. To match multiple patterns, wrap the patterns in {} and separate them with commas. For example: '{config.yaml,env-use2/*}'
• include (String) Glob pattern to match paths against that should be explicitly included during manifest generation. If this field is set, only matching manifests will be included. To match multiple patterns, wrap the patterns in {} and separate them with commas. For example: '{.yml,.yaml}'
• jsonnet (Attributes) Jsonnet specific options. (see below for nested schema)
• recurse (Boolean) Whether to scan a directory recursively for manifests.

Nested Schema for spec.sources.directory.jsonnet

Read-Only:

• ext_vars (Attributes List) List of Jsonnet External Variables. (see below for nested schema)
• libs (List of String) Additional library search dirs.
• tlas (Attributes List) List of Jsonnet Top-level Arguments (see below for nested schema)

Nested Schema for spec.sources.directory.jsonnet.ext_vars

Read-Only:

• code (Boolean) Determines whether the variable should be evaluated as jsonnet code or treated as string.
• name (String) Name of Jsonnet variable.
• value (String) Value of Jsonnet variable.

Nested Schema for spec.sources.directory.jsonnet.tlas

Read-Only:

• code (Boolean) Determines whether the variable should be evaluated as jsonnet code or treated as string.
• name (String) Name of Jsonnet variable.
• value (String) Value of Jsonnet variable.

Nested Schema for spec.sources.helm

Read-Only:

• file_parameters (Attributes List) File parameters for the helm template. (see below for nested schema)
• ignore_missing_value_files (Boolean) Prevents 'helm template' from failing when value_files do not exist locally by not appending them to 'helm template --values'.
• parameters (Attributes List) Helm parameters which are passed to the helm template command upon manifest generation. (see below for nested schema)
• pass_credentials (Boolean) If true then adds '--pass-credentials' to Helm commands to pass credentials to all domains.
• release_name (String) Helm release name. If omitted it will use the application name.
• skip_crds (Boolean) Whether to skip custom resource definition installation step (Helm's --skip-crds).
• value_files (List of String) List of Helm value files to use when generating a template.
• values (String) Helm values to be passed to 'helm template', typically defined as a Attribute.

Nested Schema for spec.sources.helm.file_parameters

Read-Only:

• name (String) Name of the Helm parameters.
• path (String) Path to the file containing the values for the Helm parameters.

Nested Schema for spec.sources.helm.parameters

Read-Only:

• force_string (Boolean) Determines whether to tell Helm to interpret booleans and numbers as strings.
• name (String) Name of the Helm parameters.
• value (String) Value of the Helm parameters.

Nested Schema for spec.sources.kustomize

Read-Only:

• common_annotations (Map of String) List of additional annotations to add to rendered manifests.
• common_labels (Map of String) List of additional labels to add to rendered manifests.
• images (Set of String) List of Kustomize image override specifications.
• name_prefix (String) Prefix appended to resources for Kustomize apps.
• name_suffix (String) Suffix appended to resources for Kustomize apps.
• version (String) Version of Kustomize to use for rendering manifests.

Nested Schema for spec.sources.plugin

Read-Only:

• env (Attributes List) Environment variables passed to the plugin. (see below for nested schema)
• name (String) Name of the plugin. Only set the plugin name if the plugin is defined in argocd-cm. If the plugin is defined as a sidecar, omit the name. The plugin will be automatically matched with the Application according to the plugin's discovery rules.
• parameters (Attributes List) Parameters to supply to config management plugin. (see below for nested schema)

Nested Schema for spec.sources.plugin.env

Read-Only:

• name (String) Name of the environment variable.
• value (String) Value of the environment variable.

Nested Schema for spec.sources.plugin.parameters

Read-Only:

• array (List of String) Value of an array type parameters.
• map (Map of String) Value of a map type parameters.
• name (String) Name identifying a parameters.
• string (String) Value of a string type parameters.

Nested Schema for spec.sync_policy

Read-Only:

• automated (Attributes) Whether to automatically keep an application synced to the target revision. (see below for nested schema)
• retry (Attributes) Controls failed sync retry behavior. (see below for nested schema)
• sync_options (Set of String) List of sync options. More info: https://argo-cd.readthedocs.io/en/stable/user-guide/sync-options/.

Nested Schema for spec.sync_policy.automated

Read-Only:

• allow_empty (Boolean) Allows apps have zero live resources.
• prune (Boolean) Whether to delete resources from the cluster that are not found in the sources anymore as part of automated sync.
• self_heal (Boolean) Whether to revert resources back to their desired state upon modification in the cluster.

Nested Schema for spec.sync_policy.retry

Read-Only:

• backoff (Attributes) Controls how to backoff on subsequent retries of failed syncs. (see below for nested schema)
• limit (Number) Maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.

Nested Schema for spec.sync_policy.retry.backoff

Read-Only:

• duration (String) Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. 2m, 1h), as a string.
• factor (Number) Factor to multiply the base duration after each failed retry.
• max_duration (String) Maximum amount of time allowed for the backoff strategy. Default unit is seconds, but could also be a duration (e.g. 2m, 1h), as a string.

Nested Schema for status

Read-Only:

• conditions (Attributes List) List of currently observed application conditions. (see below for nested schema)
• health (Attributes) Application's current health status. (see below for nested schema)
• operation_state (Attributes) Information about any ongoing operations, such as a sync. (see below for nested schema)
• reconciled_at (String) When the application state was reconciled using the latest git version.
• resources (Attributes List) List of Kubernetes resources managed by this application. (see below for nested schema)
• summary (Attributes) List of URLs and container images used by this application. (see below for nested schema)
• sync (Attributes) Application's current sync status (see below for nested schema)

Nested Schema for status.conditions

Read-Only:

• last_transition_time (String) The time the condition was last observed.
• message (String) Human-readable message indicating details about condition.
• type (String) Application condition type.

Nested Schema for status.health

Read-Only:

• message (String) Human-readable informational message describing the health status.
• status (String) Status code of the application or resource.

Nested Schema for status.operation_state

Read-Only:

• finished_at (String) Time of operation completion.
• message (String) Any pertinent messages when attempting to perform operation (typically errors).
• phase (String) The current phase of the operation.
• retry_count (Number) Count of operation retries.
• started_at (String) Time of operation start.

Nested Schema for status.resources

Read-Only:

• group (String) The Kubernetes resource Group.
• health (Attributes) Resource health status. (see below for nested schema)
• hook (Boolean) Indicates whether or not this resource has a hook annotation.
• kind (String) The Kubernetes resource Kind.
• name (String) The Kubernetes resource Name.
• namespace (String) The Kubernetes resource Namespace.
• requires_pruning (Boolean) Indicates if the resources requires pruning or not.
• status (String) Resource sync status.
• sync_wave (Number) Sync wave.
• version (String) The Kubernetes resource Version.

Nested Schema for status.resources.health

Read-Only:

• message (String) Human-readable informational message describing the health status.
• status (String) Status code of the application or resource.

Nested Schema for status.summary

Read-Only:

• external_urls (List of String) All external URLs of application child resources.
• images (List of String) All images of application child resources.

Nested Schema for status.sync

Read-Only:

• revisions (List of String) Information about the revision(s) the comparison has been performed to.
• status (String) Sync state of the comparison.