Argo CD
Argo CD base resources
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/argo-cd/latest.json |
|---|---|
| Source | https://raw.githubusercontent.com/argoproj/argo-schema-generator/main/schema/argo_cd_kustomize_schema.json |
Validate with Lintel
npx @lintel/lintel checkDefinitions
AWSAuthConfig is an AWS IAM authentication configuration
ClusterName contains AWS cluster name
Profile contains optional role ARN. If set then AWS IAM Authenticator uses the profile to perform cluster operations instead of the default AWS credential provider chain.
RoleARN contains optional role ARN. If set then AWS IAM Authenticator assume a role to perform cluster operations instead of the default AWS credential provider chain.
AppProject provides a logical grouping of applications, providing controls for: * where the apps may deploy to (cluster whitelist) * what may be deployed (repository whitelist, resource whitelist/blacklist) * who can access these applications (roles, OIDC group claims bindings) * and what they can do (RBAC policies) * automation access to these roles (JWT tokens)
{}AppProjectSpec is the specification of an AppProject
13 nested properties
ClusterResourceBlacklist contains list of blacklisted cluster level resources
ClusterResourceWhitelist contains list of whitelisted cluster level resources
Description contains optional project description
Destinations contains list of destinations available for deployment
NamespaceResourceBlacklist contains list of blacklisted namespace level resources
NamespaceResourceWhitelist contains list of whitelisted namespace level resources
OrphanedResourcesMonitorSettings holds settings of orphaned resources monitoring
2 nested properties
Ignore contains a list of resources that are to be excluded from orphaned resources monitoring
Warn indicates if warning condition should be created for apps which have orphaned resources
PermitOnlyProjectScopedClusters determines whether destinations can only reference clusters which are project-scoped
Roles are user defined RBAC roles associated with this project
SignatureKeys contains a list of PGP key IDs that commits in Git must be signed with in order to be allowed for sync
SourceNamespaces defines the namespaces application resources are allowed to be created in
SourceRepos contains list of repository URLs which can be used for deployment
SyncWindows controls when syncs can be run for apps in this project
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 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
AppProjectList is list of AppProject resources
{}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 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
AppProjectSpec is the specification of an AppProject
ClusterResourceBlacklist contains list of blacklisted cluster level resources
ClusterResourceWhitelist contains list of whitelisted cluster level resources
Description contains optional project description
Destinations contains list of destinations available for deployment
NamespaceResourceBlacklist contains list of blacklisted namespace level resources
NamespaceResourceWhitelist contains list of whitelisted namespace level resources
OrphanedResourcesMonitorSettings holds settings of orphaned resources monitoring
2 nested properties
Ignore contains a list of resources that are to be excluded from orphaned resources monitoring
Warn indicates if warning condition should be created for apps which have orphaned resources
PermitOnlyProjectScopedClusters determines whether destinations can only reference clusters which are project-scoped
Roles are user defined RBAC roles associated with this project
SignatureKeys contains a list of PGP key IDs that commits in Git must be signed with in order to be allowed for sync
SourceNamespaces defines the namespaces application resources are allowed to be created in
SourceRepos contains list of repository URLs which can be used for deployment
SyncWindows controls when syncs can be run for apps in this project
AppProjectStatus contains status information for AppProject CRs
JWTTokensByRole contains a list of JWT tokens issued for a given role
Application is a definition of Application resource.
{}ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
8 nested properties
ApplicationDestination holds information about the application's destination
3 nested properties
Name is an alternate way of specifying the target cluster by its symbolic name. This must be set if Server is not set.
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 specifies the URL of the target cluster's Kubernetes control plane API. This must be set if Name is not set.
Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project.
IgnoreDifferences is a list of resources and their fields which should be ignored during comparison
Info contains a list of information (URLs, email addresses, and plain text) that relates to the application
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.
ApplicationSource contains all required information about the source of an application
9 nested properties
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
ApplicationSourceDirectory holds options for applications of type plain YAML or Jsonnet
ApplicationSourceHelm holds helm specific options
ApplicationSourceKustomize holds options specific to an Application source specific to Kustomize
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
ApplicationSourcePlugin holds options specific to config management plugins
Ref is reference to another source within sources field. This field will not be used if used with a source tag.
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 is a reference to the location of the application's manifests or chart
SyncPolicy controls when a sync will be performed in response to updates in git
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 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
Operation contains information about a requested or running operation
4 nested properties
Info is a list of informational items for this operation
OperationInitiator contains information about the initiator of an operation
2 nested properties
Automated is set to true if operation was initiated automatically by the application controller.
Username contains the name of a user who started operation
RetryStrategy contains information about the strategy to apply when a sync failed
2 nested properties
Backoff is the backoff strategy to use on subsequent retries for failing syncs
Limit is the maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.
SyncOperation contains details about a sync operation.
10 nested properties
DryRun specifies to perform a kubectl apply --dry-run without actually performing the sync
Manifests is an optional field that overrides sync source with a local directory for development
Prune specifies to delete resources from the cluster that are no longer tracked in git
Resources describes which resources shall be part of the sync
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 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.
ApplicationSource contains all required information about the source of an application
Sources overrides the source definition set in the application. This is typically set in a Rollback operation and is nil during a Sync operation
SyncOptions provide per-sync sync-options, e.g. Validate=false
SyncStrategy controls the manner in which a sync is performed
ApplicationStatus contains status information for the application
13 nested properties
Conditions is a list of currently observed application conditions
ControllerNamespace indicates the namespace in which the application controller is located
HealthStatus contains information about the currently observed health state of an application or resource
2 nested properties
Message is a human-readable informational message describing the health status
Status holds the status code of the application or resource
History contains information about the application's sync history
ObservedAt indicates when the application state was updated without querying latest git state Deprecated: controller no longer updates ObservedAt field
OperationState contains information about state of a running operation
7 nested properties
Operation contains information about a requested or running operation
Phase is the current phase of the operation
StartedAt contains time of operation start
FinishedAt contains time of operation completion
Message holds any pertinent messages when attempting to perform operation (typically errors).
RetryCount contains time of operation retries
SyncOperationResult represent result of sync operation
ReconciledAt indicates when the application state was reconciled using the latest git version
ResourceHealthSource indicates where the resource health status is stored: inline if not set or appTree
Resources is a list of Kubernetes resources managed by this application
SourceType specifies the type of this application
SourceTypes specifies the type of the sources included in the application
ApplicationSummary contains information about URLs and container images used by an application
2 nested properties
ExternalURLs holds all external URLs of application child resources.
Images holds all images of application child resources.
SyncStatus contains information about the currently observed live and desired states of an application
4 nested properties
Status is the sync state of the comparison
ComparedTo contains application source and target which was used for resources comparison
Revision contains information about the revision the comparison has been performed to
Revisions contains information about the revisions of multiple sources the comparison has been performed to
ApplicationCondition contains details about an application condition, which is usually an error or warning
Message contains human-readable message indicating details about condition
Type is an application condition type
LastTransitionTime is the time the condition was last observed
ApplicationDestination holds information about the application's destination
Name is an alternate way of specifying the target cluster by its symbolic name. This must be set if Server is not set.
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 specifies the URL of the target cluster's Kubernetes control plane API. This must be set if Name is not set.
ApplicationList is list of Application resources
{}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 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
ApplicationSet is a set of Application resources
{}ApplicationSetSpec represents a class of application set state.
10 nested properties
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
ApplyNestedSelectors enables selectors defined within the generators of two level-nested matrix or merge generators
2 nested properties
ApplicationSetStrategy configures how generated Applications are updated in sequence.
2 nested properties
ApplicationSetSyncPolicy configures how generated Applications will relate to their ApplicationSet.
2 nested properties
ApplicationsSync represents the policy applied on the generated applications. Possible values are create-only, create-update, create-delete, sync
PreserveResourcesOnDeletion will preserve resources on deletion. If PreserveResourcesOnDeletion is set to true, these Applications will not be deleted.
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 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
ApplicationSetStatus defines the observed state of ApplicationSet
2 nested properties
INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run "make" to regenerate code after modifying this file
ApplicationSetApplicationStatus contains details about each Application managed by the ApplicationSet
Application contains the name of the Application resource
Message contains human-readable message indicating details about the status
Status contains the AppSet's perceived status of the managed Application resource: (Waiting, Pending, Progressing, Healthy)
Step tracks which step this Application should be updated in
LastTransitionTime is the time the status was last updated
ApplicationSetCondition contains details about an applicationset condition, which is usally an error or warning
Message contains human-readable message indicating details about condition
Single word camelcase representing the reason for the status eg ErrorOccurred
True/False/Unknown
Type is an applicationset condition type
LastTransitionTime is the time the condition was last observed
ApplicationSetGenerator represents a generator at the top level of an ApplicationSet.
DuckType defines a generator to match against clusters registered with ArgoCD.
6 nested properties
ConfigMapRef is a ConfigMap with the duck type definitions needed to retrieve the data this includes apiVersion(group/version), kind, matchKey and validation settings Name is the resource name of the kind, group and version, defined in the ConfigMapRef RequeueAfterSeconds is how long before the duckType will be rechecked for a change
{}ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
Values contains key/value pairs which are passed directly as parameters to the template
ClusterGenerator defines a generator to match against clusters registered with ArgoCD.
3 nested properties
Selector defines a label selector to match against all clusters registered with ArgoCD. Clusters today are stored as Kubernetes Secrets, thus the Secret labels will be used for matching the selector.
{}ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
Values contains key/value pairs which are passed directly as parameters to the template
8 nested properties
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
Values contains key/value pairs which are passed directly as parameters to the template
ListGenerator include items info
3 nested properties
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
MatrixGenerator generates the cartesian product of two sets of parameters. The parameters are defined by two nested generators.
2 nested properties
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
MergeGenerator merges the output of two or more generators. Where the values for all specified merge keys are equal between two sets of generated parameters, the parameter sets will be merged with the parameters from the latter generator taking precedence. Parameter sets with merge keys not present in the base generator's params will be ignored. For example, if the first generator produced [{a: '1', b: '2'}, {c: '1', d: '1'}] and the second generator produced [{'a': 'override'}], the united parameters for merge keys = ['a'] would be [{a: 'override', b: '1'}, {c: '1', d: '1'}].
MergeGenerator supports template overriding. If a MergeGenerator is one of multiple top-level generators, its template will be merged with the top-level generator before the parameters are applied.
3 nested properties
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
PluginGenerator defines connection info specific to Plugin.
5 nested properties
1 nested properties
Name of the ConfigMap
1 nested properties
Parameters contains the information to pass to the plugin. It is a map. The keys must be strings, and the values can be any type.
RequeueAfterSeconds determines how long the ApplicationSet controller will wait before reconciling the ApplicationSet again.
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
Values contains key/value pairs which are passed directly as parameters to the template. These values will not be sent as parameters to the plugin.
PullRequestGenerator defines a generator that scrapes a PullRequest API to find candidate pull requests.
9 nested properties
PullRequestGeneratorAzureDevOps defines connection info specific to AzureDevOps.
6 nested properties
Azure DevOps org to scan. Required.
Azure DevOps project name to scan. Required.
Azure DevOps repo name to scan. Required.
The Azure DevOps API URL to talk to. If blank, use https://dev.azure.com/.
Labels is used to filter the PRs that you want to target
Utility struct for a reference to a secret key.
PullRequestGeneratorBitbucket defines connection info specific to Bitbucket.
5 nested properties
Workspace to scan. Required.
Repo name to scan. Required.
The Bitbucket REST API URL to talk to. If blank, uses https://api.bitbucket.org/2.0.
BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.
BearerTokenBitbucketCloud defines the Bearer token for BitBucket AppToken auth.
PullRequestGeneratorBitbucketServer defines connection info specific to BitbucketServer.
4 nested properties
The Bitbucket REST API URL to talk to e.g. https://bitbucket.org/rest Required.
Project to scan. Required.
Repo name to scan. Required.
BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.
Filters for which pull requests should be considered.
PullRequestGeneratorGitea defines connection info specific to Gitea.
5 nested properties
The Gitea API URL to talk to. Required
Gitea org or user to scan. Required.
Gitea repo name to scan. Required.
Allow insecure tls, for self-signed certificates; default: false.
Utility struct for a reference to a secret key.
PullRequestGenerator defines connection info specific to GitHub.
6 nested properties
GitHub org or user to scan. Required.
GitHub repo name to scan. Required.
The GitHub API URL to talk to. If blank, use https://api.github.com/.
AppSecretName is a reference to a GitHub App repo-creds secret with permission to access pull requests.
Labels is used to filter the PRs that you want to target
Utility struct for a reference to a secret key.
PullRequestGeneratorGitLab defines connection info specific to GitLab.
6 nested properties
GitLab project to scan. Required.
The GitLab API URL to talk to. If blank, uses https://gitlab.com/.
Skips validating the SCM provider's TLS certificate - useful for self-signed certificates.; default: false
Labels is used to filter the MRs that you want to target
PullRequestState is an additional MRs filter to get only those with a certain state. Default: "" (all states)
Utility struct for a reference to a secret key.
Standard parameters.
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
SCMProviderGenerator defines a generator that scrapes a SCMaaS API to find candidate repos.
12 nested properties
SCMProviderGeneratorAWSCodeCommit defines connection info specific to AWS CodeCommit.
4 nested properties
Scan all branches instead of just the default branch.
Region provides the AWS region to discover repos. if not provided, AppSet controller will infer the current region from environment.
Role provides the AWS IAM role to assume, for cross-account repo discovery if not provided, AppSet controller will use its pod/node identity to discover.
TagFilters provides the tag filter(s) for repo discovery
SCMProviderGeneratorAzureDevOps defines connection info specific to Azure DevOps.
5 nested properties
Utility struct for a reference to a secret key.
Azure Devops organization. Required. E.g. "my-organization".
Azure Devops team project. Required. E.g. "my-team".
Scan all branches instead of just the default branch.
The URL to Azure DevOps. If blank, use https://dev.azure.com.
SCMProviderGeneratorBitbucket defines connection info specific to Bitbucket Cloud (API version 2).
4 nested properties
Utility struct for a reference to a secret key.
Bitbucket workspace to scan. Required.
Bitbucket user to use when authenticating. Should have a "member" role to be able to read all repositories and branches. Required
Scan all branches instead of just the main branch.
SCMProviderGeneratorBitbucketServer defines connection info specific to Bitbucket Server.
4 nested properties
The Bitbucket Server REST API URL to talk to. Required.
Project to scan. Required.
Scan all branches instead of just the default branch.
BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.
Which protocol to use for the SCM URL. Default is provider-specific but ssh if possible. Not all providers necessarily support all protocols.
Filters for which repos should be considered.
SCMProviderGeneratorGitea defines a connection info specific to Gitea.
5 nested properties
The Gitea URL to talk to. For example https://gitea.mydomain.com/.
Gitea organization or user to scan. Required.
Scan all branches instead of just the default branch.
Allow self-signed TLS / Certificates; default: false
Utility struct for a reference to a secret key.
SCMProviderGeneratorGithub defines connection info specific to GitHub.
5 nested properties
GitHub org to scan. Required.
Scan all branches instead of just the default branch.
The GitHub API URL to talk to. If blank, use https://api.github.com/.
AppSecretName is a reference to a GitHub App repo-creds secret.
Utility struct for a reference to a secret key.
SCMProviderGeneratorGitlab defines connection info specific to Gitlab.
8 nested properties
Gitlab group to scan. Required. You can use either the project id (recommended) or the full namespaced path.
Scan all branches instead of just the default branch.
The Gitlab API URL to talk to.
When recursing through subgroups, also include shared Projects (true) or scan only the subgroups under same path (false). Defaults to "true"
Recurse through subgroups (true) or scan only the base group (false). Defaults to "false"
Skips validating the SCM provider's TLS certificate - useful for self-signed certificates.; default: false
Utility struct for a reference to a secret key.
Filter repos list based on Gitlab Topic.
Standard parameters.
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
Values contains key/value pairs which are passed directly as parameters to the template
Selector allows to post-filter all generator.
ApplicationSetList contains a list of ApplicationSet
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 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
{}ApplicationSetNestedGenerator represents a generator nested within a combination-type generator (MatrixGenerator or MergeGenerator).
DuckType defines a generator to match against clusters registered with ArgoCD.
6 nested properties
ConfigMapRef is a ConfigMap with the duck type definitions needed to retrieve the data this includes apiVersion(group/version), kind, matchKey and validation settings Name is the resource name of the kind, group and version, defined in the ConfigMapRef RequeueAfterSeconds is how long before the duckType will be rechecked for a change
{}ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
Values contains key/value pairs which are passed directly as parameters to the template
ClusterGenerator defines a generator to match against clusters registered with ArgoCD.
3 nested properties
Selector defines a label selector to match against all clusters registered with ArgoCD. Clusters today are stored as Kubernetes Secrets, thus the Secret labels will be used for matching the selector.
{}ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
Values contains key/value pairs which are passed directly as parameters to the template
8 nested properties
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
Values contains key/value pairs which are passed directly as parameters to the template
ListGenerator include items info
3 nested properties
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
Matrix should have the form of NestedMatrixGenerator
Merge should have the form of NestedMergeGenerator
PluginGenerator defines connection info specific to Plugin.
5 nested properties
1 nested properties
Name of the ConfigMap
1 nested properties
Parameters contains the information to pass to the plugin. It is a map. The keys must be strings, and the values can be any type.
RequeueAfterSeconds determines how long the ApplicationSet controller will wait before reconciling the ApplicationSet again.
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
Values contains key/value pairs which are passed directly as parameters to the template. These values will not be sent as parameters to the plugin.
PullRequestGenerator defines a generator that scrapes a PullRequest API to find candidate pull requests.
9 nested properties
PullRequestGeneratorAzureDevOps defines connection info specific to AzureDevOps.
6 nested properties
Azure DevOps org to scan. Required.
Azure DevOps project name to scan. Required.
Azure DevOps repo name to scan. Required.
The Azure DevOps API URL to talk to. If blank, use https://dev.azure.com/.
Labels is used to filter the PRs that you want to target
Utility struct for a reference to a secret key.
PullRequestGeneratorBitbucket defines connection info specific to Bitbucket.
5 nested properties
Workspace to scan. Required.
Repo name to scan. Required.
The Bitbucket REST API URL to talk to. If blank, uses https://api.bitbucket.org/2.0.
BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.
BearerTokenBitbucketCloud defines the Bearer token for BitBucket AppToken auth.
PullRequestGeneratorBitbucketServer defines connection info specific to BitbucketServer.
4 nested properties
The Bitbucket REST API URL to talk to e.g. https://bitbucket.org/rest Required.
Project to scan. Required.
Repo name to scan. Required.
BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.
Filters for which pull requests should be considered.
PullRequestGeneratorGitea defines connection info specific to Gitea.
5 nested properties
The Gitea API URL to talk to. Required
Gitea org or user to scan. Required.
Gitea repo name to scan. Required.
Allow insecure tls, for self-signed certificates; default: false.
Utility struct for a reference to a secret key.
PullRequestGenerator defines connection info specific to GitHub.
6 nested properties
GitHub org or user to scan. Required.
GitHub repo name to scan. Required.
The GitHub API URL to talk to. If blank, use https://api.github.com/.
AppSecretName is a reference to a GitHub App repo-creds secret with permission to access pull requests.
Labels is used to filter the PRs that you want to target
Utility struct for a reference to a secret key.
PullRequestGeneratorGitLab defines connection info specific to GitLab.
6 nested properties
GitLab project to scan. Required.
The GitLab API URL to talk to. If blank, uses https://gitlab.com/.
Skips validating the SCM provider's TLS certificate - useful for self-signed certificates.; default: false
Labels is used to filter the MRs that you want to target
PullRequestState is an additional MRs filter to get only those with a certain state. Default: "" (all states)
Utility struct for a reference to a secret key.
Standard parameters.
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
SCMProviderGenerator defines a generator that scrapes a SCMaaS API to find candidate repos.
12 nested properties
SCMProviderGeneratorAWSCodeCommit defines connection info specific to AWS CodeCommit.
4 nested properties
Scan all branches instead of just the default branch.
Region provides the AWS region to discover repos. if not provided, AppSet controller will infer the current region from environment.
Role provides the AWS IAM role to assume, for cross-account repo discovery if not provided, AppSet controller will use its pod/node identity to discover.
TagFilters provides the tag filter(s) for repo discovery
SCMProviderGeneratorAzureDevOps defines connection info specific to Azure DevOps.
5 nested properties
Utility struct for a reference to a secret key.
Azure Devops organization. Required. E.g. "my-organization".
Azure Devops team project. Required. E.g. "my-team".
Scan all branches instead of just the default branch.
The URL to Azure DevOps. If blank, use https://dev.azure.com.
SCMProviderGeneratorBitbucket defines connection info specific to Bitbucket Cloud (API version 2).
4 nested properties
Utility struct for a reference to a secret key.
Bitbucket workspace to scan. Required.
Bitbucket user to use when authenticating. Should have a "member" role to be able to read all repositories and branches. Required
Scan all branches instead of just the main branch.
SCMProviderGeneratorBitbucketServer defines connection info specific to Bitbucket Server.
4 nested properties
The Bitbucket Server REST API URL to talk to. Required.
Project to scan. Required.
Scan all branches instead of just the default branch.
BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.
Which protocol to use for the SCM URL. Default is provider-specific but ssh if possible. Not all providers necessarily support all protocols.
Filters for which repos should be considered.
SCMProviderGeneratorGitea defines a connection info specific to Gitea.
5 nested properties
The Gitea URL to talk to. For example https://gitea.mydomain.com/.
Gitea organization or user to scan. Required.
Scan all branches instead of just the default branch.
Allow self-signed TLS / Certificates; default: false
Utility struct for a reference to a secret key.
SCMProviderGeneratorGithub defines connection info specific to GitHub.
5 nested properties
GitHub org to scan. Required.
Scan all branches instead of just the default branch.
The GitHub API URL to talk to. If blank, use https://api.github.com/.
AppSecretName is a reference to a GitHub App repo-creds secret.
Utility struct for a reference to a secret key.
SCMProviderGeneratorGitlab defines connection info specific to Gitlab.
8 nested properties
Gitlab group to scan. Required. You can use either the project id (recommended) or the full namespaced path.
Scan all branches instead of just the default branch.
The Gitlab API URL to talk to.
When recursing through subgroups, also include shared Projects (true) or scan only the subgroups under same path (false). Defaults to "true"
Recurse through subgroups (true) or scan only the base group (false). Defaults to "false"
Skips validating the SCM provider's TLS certificate - useful for self-signed certificates.; default: false
Utility struct for a reference to a secret key.
Filter repos list based on Gitlab Topic.
Standard parameters.
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
Values contains key/value pairs which are passed directly as parameters to the template
Selector allows to post-filter all generator.
ApplicationSetResourceIgnoreDifferences configures how the ApplicationSet controller will ignore differences in live applications when applying changes from generated applications.
JQPathExpressions is a list of JQ path expressions to fields to ignore differences for.
JSONPointers is a list of JSON pointers to fields to ignore differences for.
Name is the name of the application to ignore differences for. If not specified, the rule applies to all applications.
ApplicationSetSpec represents a class of application set state.
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
5 nested properties
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
8 nested properties
ApplicationDestination holds information about the application's destination
Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project.
IgnoreDifferences is a list of resources and their fields which should be ignored during comparison
Info contains a list of information (URLs, email addresses, and plain text) that relates to the application
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.
ApplicationSource contains all required information about the source of an application
Sources is a reference to the location of the application's manifests or chart
SyncPolicy controls when a sync will be performed in response to updates in git
ApplyNestedSelectors enables selectors defined within the generators of two level-nested matrix or merge generators
2 nested properties
ApplicationSetStrategy configures how generated Applications are updated in sequence.
2 nested properties
1 nested properties
ApplicationSetSyncPolicy configures how generated Applications will relate to their ApplicationSet.
2 nested properties
ApplicationsSync represents the policy applied on the generated applications. Possible values are create-only, create-update, create-delete, sync
PreserveResourcesOnDeletion will preserve resources on deletion. If PreserveResourcesOnDeletion is set to true, these Applications will not be deleted.
ApplicationSetStatus defines the observed state of ApplicationSet
INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run "make" to regenerate code after modifying this file
ApplicationSetStrategy configures how generated Applications are updated in sequence.
1 nested properties
ApplicationSetSyncPolicy configures how generated Applications will relate to their ApplicationSet.
ApplicationsSync represents the policy applied on the generated applications. Possible values are create-only, create-update, create-delete, sync
PreserveResourcesOnDeletion will preserve resources on deletion. If PreserveResourcesOnDeletion is set to true, these Applications will not be deleted.
ApplicationSetTemplate represents argocd ApplicationSpec
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
5 nested properties
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
8 nested properties
ApplicationDestination holds information about the application's destination
3 nested properties
Name is an alternate way of specifying the target cluster by its symbolic name. This must be set if Server is not set.
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 specifies the URL of the target cluster's Kubernetes control plane API. This must be set if Name is not set.
Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project.
IgnoreDifferences is a list of resources and their fields which should be ignored during comparison
Info contains a list of information (URLs, email addresses, and plain text) that relates to the application
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.
ApplicationSource contains all required information about the source of an application
9 nested properties
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
ApplicationSourceDirectory holds options for applications of type plain YAML or Jsonnet
ApplicationSourceHelm holds helm specific options
ApplicationSourceKustomize holds options specific to an Application source specific to Kustomize
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
ApplicationSourcePlugin holds options specific to config management plugins
Ref is reference to another source within sources field. This field will not be used if used with a source tag.
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 is a reference to the location of the application's manifests or chart
SyncPolicy controls when a sync will be performed in response to updates in git
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSetTerminalGenerator represents a generator nested within a nested generator (for example, a list within a merge within a matrix). A generator at this level may not be a combination-type generator (MatrixGenerator or MergeGenerator). ApplicationSet enforces this nesting depth limit because CRDs do not support recursive types. https://github.com/kubernetes-sigs/controller-tools/issues/477
DuckType defines a generator to match against clusters registered with ArgoCD.
6 nested properties
ConfigMapRef is a ConfigMap with the duck type definitions needed to retrieve the data this includes apiVersion(group/version), kind, matchKey and validation settings Name is the resource name of the kind, group and version, defined in the ConfigMapRef RequeueAfterSeconds is how long before the duckType will be rechecked for a change
{}ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
Values contains key/value pairs which are passed directly as parameters to the template
ClusterGenerator defines a generator to match against clusters registered with ArgoCD.
3 nested properties
Selector defines a label selector to match against all clusters registered with ArgoCD. Clusters today are stored as Kubernetes Secrets, thus the Secret labels will be used for matching the selector.
{}ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
Values contains key/value pairs which are passed directly as parameters to the template
8 nested properties
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
Values contains key/value pairs which are passed directly as parameters to the template
ListGenerator include items info
3 nested properties
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
PluginGenerator defines connection info specific to Plugin.
5 nested properties
1 nested properties
Name of the ConfigMap
1 nested properties
Parameters contains the information to pass to the plugin. It is a map. The keys must be strings, and the values can be any type.
RequeueAfterSeconds determines how long the ApplicationSet controller will wait before reconciling the ApplicationSet again.
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
Values contains key/value pairs which are passed directly as parameters to the template. These values will not be sent as parameters to the plugin.
PullRequestGenerator defines a generator that scrapes a PullRequest API to find candidate pull requests.
9 nested properties
PullRequestGeneratorAzureDevOps defines connection info specific to AzureDevOps.
6 nested properties
Azure DevOps org to scan. Required.
Azure DevOps project name to scan. Required.
Azure DevOps repo name to scan. Required.
The Azure DevOps API URL to talk to. If blank, use https://dev.azure.com/.
Labels is used to filter the PRs that you want to target
Utility struct for a reference to a secret key.
PullRequestGeneratorBitbucket defines connection info specific to Bitbucket.
5 nested properties
Workspace to scan. Required.
Repo name to scan. Required.
The Bitbucket REST API URL to talk to. If blank, uses https://api.bitbucket.org/2.0.
BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.
BearerTokenBitbucketCloud defines the Bearer token for BitBucket AppToken auth.
PullRequestGeneratorBitbucketServer defines connection info specific to BitbucketServer.
4 nested properties
The Bitbucket REST API URL to talk to e.g. https://bitbucket.org/rest Required.
Project to scan. Required.
Repo name to scan. Required.
BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.
Filters for which pull requests should be considered.
PullRequestGeneratorGitea defines connection info specific to Gitea.
5 nested properties
The Gitea API URL to talk to. Required
Gitea org or user to scan. Required.
Gitea repo name to scan. Required.
Allow insecure tls, for self-signed certificates; default: false.
Utility struct for a reference to a secret key.
PullRequestGenerator defines connection info specific to GitHub.
6 nested properties
GitHub org or user to scan. Required.
GitHub repo name to scan. Required.
The GitHub API URL to talk to. If blank, use https://api.github.com/.
AppSecretName is a reference to a GitHub App repo-creds secret with permission to access pull requests.
Labels is used to filter the PRs that you want to target
Utility struct for a reference to a secret key.
PullRequestGeneratorGitLab defines connection info specific to GitLab.
6 nested properties
GitLab project to scan. Required.
The GitLab API URL to talk to. If blank, uses https://gitlab.com/.
Skips validating the SCM provider's TLS certificate - useful for self-signed certificates.; default: false
Labels is used to filter the MRs that you want to target
PullRequestState is an additional MRs filter to get only those with a certain state. Default: "" (all states)
Utility struct for a reference to a secret key.
Standard parameters.
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
SCMProviderGenerator defines a generator that scrapes a SCMaaS API to find candidate repos.
12 nested properties
SCMProviderGeneratorAWSCodeCommit defines connection info specific to AWS CodeCommit.
4 nested properties
Scan all branches instead of just the default branch.
Region provides the AWS region to discover repos. if not provided, AppSet controller will infer the current region from environment.
Role provides the AWS IAM role to assume, for cross-account repo discovery if not provided, AppSet controller will use its pod/node identity to discover.
TagFilters provides the tag filter(s) for repo discovery
SCMProviderGeneratorAzureDevOps defines connection info specific to Azure DevOps.
5 nested properties
Utility struct for a reference to a secret key.
Azure Devops organization. Required. E.g. "my-organization".
Azure Devops team project. Required. E.g. "my-team".
Scan all branches instead of just the default branch.
The URL to Azure DevOps. If blank, use https://dev.azure.com.
SCMProviderGeneratorBitbucket defines connection info specific to Bitbucket Cloud (API version 2).
4 nested properties
Utility struct for a reference to a secret key.
Bitbucket workspace to scan. Required.
Bitbucket user to use when authenticating. Should have a "member" role to be able to read all repositories and branches. Required
Scan all branches instead of just the main branch.
SCMProviderGeneratorBitbucketServer defines connection info specific to Bitbucket Server.
4 nested properties
The Bitbucket Server REST API URL to talk to. Required.
Project to scan. Required.
Scan all branches instead of just the default branch.
BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.
Which protocol to use for the SCM URL. Default is provider-specific but ssh if possible. Not all providers necessarily support all protocols.
Filters for which repos should be considered.
SCMProviderGeneratorGitea defines a connection info specific to Gitea.
5 nested properties
The Gitea URL to talk to. For example https://gitea.mydomain.com/.
Gitea organization or user to scan. Required.
Scan all branches instead of just the default branch.
Allow self-signed TLS / Certificates; default: false
Utility struct for a reference to a secret key.
SCMProviderGeneratorGithub defines connection info specific to GitHub.
5 nested properties
GitHub org to scan. Required.
Scan all branches instead of just the default branch.
The GitHub API URL to talk to. If blank, use https://api.github.com/.
AppSecretName is a reference to a GitHub App repo-creds secret.
Utility struct for a reference to a secret key.
SCMProviderGeneratorGitlab defines connection info specific to Gitlab.
8 nested properties
Gitlab group to scan. Required. You can use either the project id (recommended) or the full namespaced path.
Scan all branches instead of just the default branch.
The Gitlab API URL to talk to.
When recursing through subgroups, also include shared Projects (true) or scan only the subgroups under same path (false). Defaults to "true"
Recurse through subgroups (true) or scan only the base group (false). Defaults to "false"
Skips validating the SCM provider's TLS certificate - useful for self-signed certificates.; default: false
Utility struct for a reference to a secret key.
Filter repos list based on Gitlab Topic.
Standard parameters.
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
Values contains key/value pairs which are passed directly as parameters to the template
Selector allows to post-filter all generator.
ApplicationSource contains all required information about the source of an application
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
ApplicationSourceDirectory holds options for applications of type plain YAML or Jsonnet
4 nested properties
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
ApplicationSourceJsonnet holds options specific to applications of type Jsonnet
3 nested properties
ExtVars is a list of Jsonnet External Variables
Additional library search dirs
TLAS is a list of Jsonnet Top-level Arguments
Recurse specifies whether to scan a directory recursively for manifests
ApplicationSourceHelm holds helm specific options
10 nested properties
FileParameters are file parameters to the helm template
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
ReleaseName is the Helm release name to use. If omitted it will use the application name
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
ValuesFiles is a list of Helm value files to use when generating a template
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 specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
Version is the Helm version to use for templating ("3")
ApplicationSourceKustomize holds options specific to an Application source specific to Kustomize
14 nested properties
CommonAnnotations is a list of additional annotations to add to rendered manifests
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
CommonLabels is a list of additional labels to add to rendered manifests
Components specifies a list of kustomize components to add to the kustomization before building
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
Images is a list of Kustomize image override specifications
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
NamePrefix is a prefix appended to resources for Kustomize apps
NameSuffix is a suffix appended to resources for Kustomize apps
Namespace sets the namespace that Kustomize adds to all resources
Patches is a list of Kustomize patches
Replicas is a list of Kustomize Replicas override specifications
Version controls which version of Kustomize to use for rendering manifests
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
ApplicationSourcePlugin holds options specific to config management plugins
3 nested properties
Ref is reference to another source within sources field. This field will not be used if used with a source tag.
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.
ApplicationSourceDirectory holds options for applications of type plain YAML or Jsonnet
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
ApplicationSourceJsonnet holds options specific to applications of type Jsonnet
3 nested properties
ExtVars is a list of Jsonnet External Variables
Additional library search dirs
TLAS is a list of Jsonnet Top-level Arguments
Recurse specifies whether to scan a directory recursively for manifests
ApplicationSourceHelm holds helm specific options
FileParameters are file parameters to the helm template
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
ReleaseName is the Helm release name to use. If omitted it will use the application name
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
ValuesFiles is a list of Helm value files to use when generating a template
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 specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
Version is the Helm version to use for templating ("3")
ApplicationSourceJsonnet holds options specific to applications of type Jsonnet
ExtVars is a list of Jsonnet External Variables
Additional library search dirs
TLAS is a list of Jsonnet Top-level Arguments
ApplicationSourceKustomize holds options specific to an Application source specific to Kustomize
CommonAnnotations is a list of additional annotations to add to rendered manifests
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
CommonLabels is a list of additional labels to add to rendered manifests
Components specifies a list of kustomize components to add to the kustomization before building
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
Images is a list of Kustomize image override specifications
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
NamePrefix is a prefix appended to resources for Kustomize apps
NameSuffix is a suffix appended to resources for Kustomize apps
Namespace sets the namespace that Kustomize adds to all resources
Patches is a list of Kustomize patches
Replicas is a list of Kustomize Replicas override specifications
Version controls which version of Kustomize to use for rendering manifests
ApplicationSourcePlugin holds options specific to config management plugins
Name is the name identifying a parameter.
String_ is the value of a string type parameter.
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
ApplicationDestination holds information about the application's destination
3 nested properties
Name is an alternate way of specifying the target cluster by its symbolic name. This must be set if Server is not set.
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 specifies the URL of the target cluster's Kubernetes control plane API. This must be set if Name is not set.
Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project.
IgnoreDifferences is a list of resources and their fields which should be ignored during comparison
Info contains a list of information (URLs, email addresses, and plain text) that relates to the application
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.
ApplicationSource contains all required information about the source of an application
9 nested properties
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
ApplicationSourceDirectory holds options for applications of type plain YAML or Jsonnet
4 nested properties
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
ApplicationSourceJsonnet holds options specific to applications of type Jsonnet
Recurse specifies whether to scan a directory recursively for manifests
ApplicationSourceHelm holds helm specific options
10 nested properties
FileParameters are file parameters to the helm template
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
ReleaseName is the Helm release name to use. If omitted it will use the application name
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
ValuesFiles is a list of Helm value files to use when generating a template
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 specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
Version is the Helm version to use for templating ("3")
ApplicationSourceKustomize holds options specific to an Application source specific to Kustomize
14 nested properties
CommonAnnotations is a list of additional annotations to add to rendered manifests
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
CommonLabels is a list of additional labels to add to rendered manifests
Components specifies a list of kustomize components to add to the kustomization before building
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
Images is a list of Kustomize image override specifications
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
NamePrefix is a prefix appended to resources for Kustomize apps
NameSuffix is a suffix appended to resources for Kustomize apps
Namespace sets the namespace that Kustomize adds to all resources
Patches is a list of Kustomize patches
Replicas is a list of Kustomize Replicas override specifications
Version controls which version of Kustomize to use for rendering manifests
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
ApplicationSourcePlugin holds options specific to config management plugins
3 nested properties
Ref is reference to another source within sources field. This field will not be used if used with a source tag.
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 is a reference to the location of the application's manifests or chart
SyncPolicy controls when a sync will be performed in response to updates in git
4 nested properties
SyncPolicyAutomated controls the behavior of an automated sync
3 nested properties
AllowEmpty allows apps have zero live resources (default: false)
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 specifies whether to revert resources back to their desired state upon modification in the cluster (default: false)
2 nested properties
RetryStrategy contains information about the strategy to apply when a sync failed
2 nested properties
Backoff is the backoff strategy to use on subsequent retries for failing syncs
Limit is the maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.
Options allow you to specify whole app sync-options
ApplicationStatus contains status information for the application
Conditions is a list of currently observed application conditions
ControllerNamespace indicates the namespace in which the application controller is located
HealthStatus contains information about the currently observed health state of an application or resource
2 nested properties
Message is a human-readable informational message describing the health status
Status holds the status code of the application or resource
History contains information about the application's sync history
ObservedAt indicates when the application state was updated without querying latest git state Deprecated: controller no longer updates ObservedAt field
OperationState contains information about state of a running operation
7 nested properties
Operation contains information about a requested or running operation
4 nested properties
Info is a list of informational items for this operation
OperationInitiator contains information about the initiator of an operation
RetryStrategy contains information about the strategy to apply when a sync failed
SyncOperation contains details about a sync operation.
Phase is the current phase of the operation
StartedAt contains time of operation start
FinishedAt contains time of operation completion
Message holds any pertinent messages when attempting to perform operation (typically errors).
RetryCount contains time of operation retries
SyncOperationResult represent result of sync operation
6 nested properties
Revision holds the revision this sync operation was performed to
Resources contains a list of sync result items for each individual resource in a sync operation
Revisions holds the revision this sync operation was performed for respective indexed source in sources field
ApplicationSource contains all required information about the source of an application
Source records the application source information of the sync, used for comparing auto-sync
ReconciledAt indicates when the application state was reconciled using the latest git version
ResourceHealthSource indicates where the resource health status is stored: inline if not set or appTree
Resources is a list of Kubernetes resources managed by this application
SourceType specifies the type of this application
SourceTypes specifies the type of the sources included in the application
ApplicationSummary contains information about URLs and container images used by an application
2 nested properties
ExternalURLs holds all external URLs of application child resources.
Images holds all images of application child resources.
SyncStatus contains information about the currently observed live and desired states of an application
4 nested properties
Status is the sync state of the comparison
ComparedTo contains application source and target which was used for resources comparison
4 nested properties
ApplicationDestination holds information about the application's destination
IgnoreDifferences is a reference to the application's ignored differences used for comparison
ApplicationSource contains all required information about the source of an application
Sources is a reference to the application's multiple sources used for comparison
Revision contains information about the revision the comparison has been performed to
Revisions contains information about the revisions of multiple sources the comparison has been performed to
ApplicationSummary contains information about URLs and container images used by an application
ExternalURLs holds all external URLs of application child resources.
Images holds all images of application child resources.
ApplicationTree holds nodes which belongs to the application
Hosts holds list of Kubernetes nodes that run application related pods
Nodes contains list of nodes which either directly managed by the application and children of directly managed nodes.
OrphanedNodes contains if or orphaned nodes: nodes which are not managed by the app but in the same namespace. List is populated only if orphaned resources enabled in app project.
ApplicationWatchEvent contains information about application change.
Application is a definition of Application resource.
6 nested properties
{}ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
8 nested properties
ApplicationDestination holds information about the application's destination
Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project.
IgnoreDifferences is a list of resources and their fields which should be ignored during comparison
Info contains a list of information (URLs, email addresses, and plain text) that relates to the application
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.
ApplicationSource contains all required information about the source of an application
Sources is a reference to the location of the application's manifests or chart
SyncPolicy controls when a sync will be performed in response to updates in git
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 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
Operation contains information about a requested or running operation
4 nested properties
Info is a list of informational items for this operation
OperationInitiator contains information about the initiator of an operation
RetryStrategy contains information about the strategy to apply when a sync failed
SyncOperation contains details about a sync operation.
ApplicationStatus contains status information for the application
13 nested properties
Conditions is a list of currently observed application conditions
ControllerNamespace indicates the namespace in which the application controller is located
HealthStatus contains information about the currently observed health state of an application or resource
History contains information about the application's sync history
ObservedAt indicates when the application state was updated without querying latest git state Deprecated: controller no longer updates ObservedAt field
OperationState contains information about state of a running operation
ReconciledAt indicates when the application state was reconciled using the latest git version
ResourceHealthSource indicates where the resource health status is stored: inline if not set or appTree
Resources is a list of Kubernetes resources managed by this application
SourceType specifies the type of this application
SourceTypes specifies the type of the sources included in the application
ApplicationSummary contains information about URLs and container images used by an application
SyncStatus contains information about the currently observed live and desired states of an application
Backoff is the backoff strategy to use on subsequent retries for failing syncs
Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")
Factor is a factor to multiply the base duration after each failed retry
MaxDuration is the maximum amount of time allowed for the backoff strategy
BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.
Utility struct for a reference to a secret key.
2 nested properties
Username for Basic auth
BearerTokenBitbucketCloud defines the Bearer token for BitBucket AppToken auth.
Utility struct for a reference to a secret key.
2 nested properties
ChartDetails contains helm chart metadata for a specific version
The URL of this projects home page, e.g. "http://example.com"
List of maintainer details, name and email, e.g. ["John Doe [email protected]"]
Cluster is the definition of a cluster resource
ClusterConfig is the configuration attributes. This structure is subset of the go-client rest.Config with annotations added for marshalling.
6 nested properties
TLSClientConfig contains settings to enable transport layer security
5 nested properties
Insecure specifies that the server should be accessed without verifying the TLS certificate. For testing only.
CAData holds PEM-encoded bytes (typically read from a root certificates bundle). CAData takes precedence over CAFile
CertData holds PEM-encoded bytes (typically read from a client certificate file). CertData takes precedence over CertFile
KeyData holds PEM-encoded bytes (typically read from a client certificate key file). KeyData takes precedence over KeyFile
ServerName is passed to the server for SNI and is used in the client to check server certificates against. If ServerName is empty, the hostname used to contact the server is used.
AWSAuthConfig is an AWS IAM authentication configuration
3 nested properties
ClusterName contains AWS cluster name
Profile contains optional role ARN. If set then AWS IAM Authenticator uses the profile to perform cluster operations instead of the default AWS credential provider chain.
RoleARN contains optional role ARN. If set then AWS IAM Authenticator assume a role to perform cluster operations instead of the default AWS credential provider chain.
Server requires Bearer authentication. This client will not attempt to use refresh tokens for an OAuth2 flow.
ExecProviderConfig is config used to call an external command to perform cluster authentication See: https://godoc.org/k8s.io/client-go/tools/clientcmd/api#ExecConfig
5 nested properties
Preferred input version of the ExecInfo
Arguments to pass to the command when executing it
Command to execute
Env defines additional environment variables to expose to the process
This text is shown to the user when the executable doesn't seem to be present
Server requires Basic authentication
Name of the cluster. If omitted, will use the server address
Server is the API server URL of the Kubernetes cluster
Annotations for cluster secret metadata
Indicates if cluster level resources should be managed. This setting is used only if cluster is connected in a namespaced mode.
ConnectionState contains information about remote resource connection state, currently used for clusters and repositories
3 nested properties
ModifiedAt contains the timestamp when this connection status has been determined
Message contains human readable information about the connection status
Status contains the current status indicator for the connection
ClusterInfo contains information about the cluster
5 nested properties
ApplicationsCount is the number of applications managed by Argo CD on the cluster
APIVersions contains list of API versions supported by the cluster
ClusterCacheInfo contains information about the cluster cache
3 nested properties
APIsCount holds number of observed Kubernetes API count
LastCacheSyncTime holds time of most recent cache synchronization
ResourcesCount holds number of observed Kubernetes resources
ConnectionState contains information about remote resource connection state, currently used for clusters and repositories
3 nested properties
ModifiedAt contains the timestamp when this connection status has been determined
Message contains human readable information about the connection status
Status contains the current status indicator for the connection
ServerVersion contains information about the Kubernetes version of the cluster
Labels for cluster secret metadata
Holds list of namespaces which are accessible in that cluster. Cluster level resources will be ignored if namespace list is not empty.
Reference between project and cluster that allow you automatically to be added as item inside Destinations project entity
RefreshRequestedAt holds time when cluster cache refresh has been requested
DEPRECATED: use Info.ServerVersion field instead. The server version
Shard contains optional shard number. Calculated on the fly by the application controller if not specified.
ClusterCacheInfo contains information about the cluster cache
APIsCount holds number of observed Kubernetes API count
LastCacheSyncTime holds time of most recent cache synchronization
ResourcesCount holds number of observed Kubernetes resources
ClusterConfig is the configuration attributes. This structure is subset of the go-client rest.Config with annotations added for marshalling.
TLSClientConfig contains settings to enable transport layer security
5 nested properties
Insecure specifies that the server should be accessed without verifying the TLS certificate. For testing only.
CAData holds PEM-encoded bytes (typically read from a root certificates bundle). CAData takes precedence over CAFile
CertData holds PEM-encoded bytes (typically read from a client certificate file). CertData takes precedence over CertFile
KeyData holds PEM-encoded bytes (typically read from a client certificate key file). KeyData takes precedence over KeyFile
ServerName is passed to the server for SNI and is used in the client to check server certificates against. If ServerName is empty, the hostname used to contact the server is used.
AWSAuthConfig is an AWS IAM authentication configuration
3 nested properties
ClusterName contains AWS cluster name
Profile contains optional role ARN. If set then AWS IAM Authenticator uses the profile to perform cluster operations instead of the default AWS credential provider chain.
RoleARN contains optional role ARN. If set then AWS IAM Authenticator assume a role to perform cluster operations instead of the default AWS credential provider chain.
Server requires Bearer authentication. This client will not attempt to use refresh tokens for an OAuth2 flow.
ExecProviderConfig is config used to call an external command to perform cluster authentication See: https://godoc.org/k8s.io/client-go/tools/clientcmd/api#ExecConfig
5 nested properties
Preferred input version of the ExecInfo
Arguments to pass to the command when executing it
Command to execute
Env defines additional environment variables to expose to the process
This text is shown to the user when the executable doesn't seem to be present
Server requires Basic authentication
ClusterGenerator defines a generator to match against clusters registered with ArgoCD.
Selector defines a label selector to match against all clusters registered with ArgoCD. Clusters today are stored as Kubernetes Secrets, thus the Secret labels will be used for matching the selector.
{}ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
5 nested properties
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
8 nested properties
ApplicationDestination holds information about the application's destination
Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project.
IgnoreDifferences is a list of resources and their fields which should be ignored during comparison
Info contains a list of information (URLs, email addresses, and plain text) that relates to the application
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.
ApplicationSource contains all required information about the source of an application
Sources is a reference to the location of the application's manifests or chart
SyncPolicy controls when a sync will be performed in response to updates in git
Values contains key/value pairs which are passed directly as parameters to the template
ClusterInfo contains information about the cluster
ApplicationsCount is the number of applications managed by Argo CD on the cluster
APIVersions contains list of API versions supported by the cluster
ClusterCacheInfo contains information about the cluster cache
3 nested properties
APIsCount holds number of observed Kubernetes API count
LastCacheSyncTime holds time of most recent cache synchronization
ResourcesCount holds number of observed Kubernetes resources
ConnectionState contains information about remote resource connection state, currently used for clusters and repositories
3 nested properties
ModifiedAt contains the timestamp when this connection status has been determined
Message contains human readable information about the connection status
Status contains the current status indicator for the connection
ServerVersion contains information about the Kubernetes version of the cluster
ClusterList is a collection of Clusters.
{}Command holds binary path and arguments list
ComparedTo contains application source and target which was used for resources comparison
ApplicationDestination holds information about the application's destination
3 nested properties
Name is an alternate way of specifying the target cluster by its symbolic name. This must be set if Server is not set.
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 specifies the URL of the target cluster's Kubernetes control plane API. This must be set if Name is not set.
IgnoreDifferences is a reference to the application's ignored differences used for comparison
ApplicationSource contains all required information about the source of an application
9 nested properties
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
ApplicationSourceDirectory holds options for applications of type plain YAML or Jsonnet
4 nested properties
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
ApplicationSourceJsonnet holds options specific to applications of type Jsonnet
Recurse specifies whether to scan a directory recursively for manifests
ApplicationSourceHelm holds helm specific options
10 nested properties
FileParameters are file parameters to the helm template
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
ReleaseName is the Helm release name to use. If omitted it will use the application name
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
ValuesFiles is a list of Helm value files to use when generating a template
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 specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
Version is the Helm version to use for templating ("3")
ApplicationSourceKustomize holds options specific to an Application source specific to Kustomize
14 nested properties
CommonAnnotations is a list of additional annotations to add to rendered manifests
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
CommonLabels is a list of additional labels to add to rendered manifests
Components specifies a list of kustomize components to add to the kustomization before building
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
Images is a list of Kustomize image override specifications
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
NamePrefix is a prefix appended to resources for Kustomize apps
NameSuffix is a suffix appended to resources for Kustomize apps
Namespace sets the namespace that Kustomize adds to all resources
Patches is a list of Kustomize patches
Replicas is a list of Kustomize Replicas override specifications
Version controls which version of Kustomize to use for rendering manifests
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
ApplicationSourcePlugin holds options specific to config management plugins
3 nested properties
Ref is reference to another source within sources field. This field will not be used if used with a source tag.
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 is a reference to the application's multiple sources used for comparison
ComponentParameter contains information about component parameter value
ConfigManagementPlugin contains config management plugin configuration
ConnectionState contains information about remote resource connection state, currently used for clusters and repositories
ModifiedAt contains the timestamp when this connection status has been determined
Message contains human readable information about the connection status
Status contains the current status indicator for the connection
DuckType defines a generator to match against clusters registered with ArgoCD.
ConfigMapRef is a ConfigMap with the duck type definitions needed to retrieve the data this includes apiVersion(group/version), kind, matchKey and validation settings Name is the resource name of the kind, group and version, defined in the ConfigMapRef RequeueAfterSeconds is how long before the duckType will be rechecked for a change
{}ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
5 nested properties
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
8 nested properties
ApplicationDestination holds information about the application's destination
Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project.
IgnoreDifferences is a list of resources and their fields which should be ignored during comparison
Info contains a list of information (URLs, email addresses, and plain text) that relates to the application
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.
ApplicationSource contains all required information about the source of an application
Sources is a reference to the location of the application's manifests or chart
SyncPolicy controls when a sync will be performed in response to updates in git
Values contains key/value pairs which are passed directly as parameters to the template
EnvEntry represents an entry in the application's environment
Name is the name of the variable, usually expressed in uppercase
Value is the value of the variable
ExecProviderConfig is config used to call an external command to perform cluster authentication See: https://godoc.org/k8s.io/client-go/tools/clientcmd/api#ExecConfig
Preferred input version of the ExecInfo
Arguments to pass to the command when executing it
Command to execute
Env defines additional environment variables to expose to the process
This text is shown to the user when the executable doesn't seem to be present
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
5 nested properties
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
8 nested properties
ApplicationDestination holds information about the application's destination
Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project.
IgnoreDifferences is a list of resources and their fields which should be ignored during comparison
Info contains a list of information (URLs, email addresses, and plain text) that relates to the application
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.
ApplicationSource contains all required information about the source of an application
Sources is a reference to the location of the application's manifests or chart
SyncPolicy controls when a sync will be performed in response to updates in git
Values contains key/value pairs which are passed directly as parameters to the template
GnuPGPublicKey is a representation of a GnuPG public key
KeyID specifies the key ID, in hexadecimal string format
Fingerprint is the fingerprint of the key
KeyData holds the raw key data, in base64 encoded format
Owner holds the owner identification, e.g. a name and e-mail address
SubType holds the key's sub type (e.g. rsa4096)
Trust holds the level of trust assigned to this key
GnuPGPublicKeyList is a collection of GnuPGPublicKey objects
{}HealthStatus contains information about the currently observed health state of an application or resource
Message is a human-readable informational message describing the health status
Status holds the status code of the application or resource
HelmFileParameter is a file parameter that's passed to helm template during manifest generation
Name is the name of the Helm parameter
Path is the path to the file containing the values for the Helm parameter
HelmOptions holds helm options
HelmParameter is a parameter that's passed to helm template during manifest generation
ForceString determines whether to tell Helm to interpret booleans and numbers as strings
Name is the name of the Helm parameter
Value is the value for the Helm parameter
HostInfo holds host name and resources metrics
{}InfoItem contains arbitrary, human readable information about an application
Name is a human readable title for this piece of information.
Value is human readable content.
JWTToken holds the issuedAt and expiresAt values of a token
JWTTokens represents a list of JWT tokens
JsonnetVar represents a variable to be passed to jsonnet during manifest generation
KnownTypeField contains mapping between CRD field and known Kubernetes type. This is mainly used for unit conversion in unknown resources (e.g. 0.1 == 100mi)
KustomizeOptions are options for kustomize to use when building manifests
BinaryPath holds optional path to kustomize binary
BuildOptions is a string of build parameters to use when calling kustomize build
7 nested properties
Number of replicas
Name of Deployment or StatefulSet
ListGenerator include items info
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
5 nested properties
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
8 nested properties
ApplicationDestination holds information about the application's destination
Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project.
IgnoreDifferences is a list of resources and their fields which should be ignored during comparison
Info contains a list of information (URLs, email addresses, and plain text) that relates to the application
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.
ApplicationSource contains all required information about the source of an application
Sources is a reference to the location of the application's manifests or chart
SyncPolicy controls when a sync will be performed in response to updates in git
MatrixGenerator generates the cartesian product of two sets of parameters. The parameters are defined by two nested generators.
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
5 nested properties
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
8 nested properties
ApplicationDestination holds information about the application's destination
Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project.
IgnoreDifferences is a list of resources and their fields which should be ignored during comparison
Info contains a list of information (URLs, email addresses, and plain text) that relates to the application
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.
ApplicationSource contains all required information about the source of an application
Sources is a reference to the location of the application's manifests or chart
SyncPolicy controls when a sync will be performed in response to updates in git
MergeGenerator merges the output of two or more generators. Where the values for all specified merge keys are equal between two sets of generated parameters, the parameter sets will be merged with the parameters from the latter generator taking precedence. Parameter sets with merge keys not present in the base generator's params will be ignored. For example, if the first generator produced [{a: '1', b: '2'}, {c: '1', d: '1'}] and the second generator produced [{'a': 'override'}], the united parameters for merge keys = ['a'] would be [{a: 'override', b: '1'}, {c: '1', d: '1'}].
MergeGenerator supports template overriding. If a MergeGenerator is one of multiple top-level generators, its template will be merged with the top-level generator before the parameters are applied.
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
5 nested properties
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
8 nested properties
ApplicationDestination holds information about the application's destination
Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project.
IgnoreDifferences is a list of resources and their fields which should be ignored during comparison
Info contains a list of information (URLs, email addresses, and plain text) that relates to the application
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.
ApplicationSource contains all required information about the source of an application
Sources is a reference to the location of the application's manifests or chart
SyncPolicy controls when a sync will be performed in response to updates in git
NestedMatrixGenerator is a MatrixGenerator nested under another combination-type generator (MatrixGenerator or MergeGenerator). NestedMatrixGenerator does not have an override template, because template overriding has no meaning within the constituent generators of combination-type generators.
NOTE: Nested matrix generator is not included directly in the CRD struct, instead it is included as a generic 'apiextensionsv1.JSON' object, and then marshalled into a NestedMatrixGenerator when processed.
NestedMergeGenerator is a MergeGenerator nested under another combination-type generator (MatrixGenerator or MergeGenerator). NestedMergeGenerator does not have an override template, because template overriding has no meaning within the constituent generators of combination-type generators.
NOTE: Nested merge generator is not included directly in the CRD struct, instead it is included as a generic 'apiextensionsv1.JSON' object, and then marshalled into a NestedMergeGenerator when processed.
Operation contains information about a requested or running operation
Info is a list of informational items for this operation
OperationInitiator contains information about the initiator of an operation
2 nested properties
Automated is set to true if operation was initiated automatically by the application controller.
Username contains the name of a user who started operation
RetryStrategy contains information about the strategy to apply when a sync failed
2 nested properties
Backoff is the backoff strategy to use on subsequent retries for failing syncs
3 nested properties
Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")
Factor is a factor to multiply the base duration after each failed retry
MaxDuration is the maximum amount of time allowed for the backoff strategy
Limit is the maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.
SyncOperation contains details about a sync operation.
10 nested properties
DryRun specifies to perform a kubectl apply --dry-run without actually performing the sync
Manifests is an optional field that overrides sync source with a local directory for development
Prune specifies to delete resources from the cluster that are no longer tracked in git
Resources describes which resources shall be part of the sync
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 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.
ApplicationSource contains all required information about the source of an application
9 nested properties
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
ApplicationSourceDirectory holds options for applications of type plain YAML or Jsonnet
ApplicationSourceHelm holds helm specific options
ApplicationSourceKustomize holds options specific to an Application source specific to Kustomize
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
ApplicationSourcePlugin holds options specific to config management plugins
Ref is reference to another source within sources field. This field will not be used if used with a source tag.
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 overrides the source definition set in the application. This is typically set in a Rollback operation and is nil during a Sync operation
SyncOptions provide per-sync sync-options, e.g. Validate=false
SyncStrategy controls the manner in which a sync is performed
OperationInitiator contains information about the initiator of an operation
Automated is set to true if operation was initiated automatically by the application controller.
Username contains the name of a user who started operation
OperationState contains information about state of a running operation
Operation contains information about a requested or running operation
4 nested properties
Info is a list of informational items for this operation
OperationInitiator contains information about the initiator of an operation
2 nested properties
Automated is set to true if operation was initiated automatically by the application controller.
Username contains the name of a user who started operation
RetryStrategy contains information about the strategy to apply when a sync failed
2 nested properties
Backoff is the backoff strategy to use on subsequent retries for failing syncs
Limit is the maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.
SyncOperation contains details about a sync operation.
10 nested properties
DryRun specifies to perform a kubectl apply --dry-run without actually performing the sync
Manifests is an optional field that overrides sync source with a local directory for development
Prune specifies to delete resources from the cluster that are no longer tracked in git
Resources describes which resources shall be part of the sync
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 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.
ApplicationSource contains all required information about the source of an application
Sources overrides the source definition set in the application. This is typically set in a Rollback operation and is nil during a Sync operation
SyncOptions provide per-sync sync-options, e.g. Validate=false
SyncStrategy controls the manner in which a sync is performed
Phase is the current phase of the operation
StartedAt contains time of operation start
FinishedAt contains time of operation completion
Message holds any pertinent messages when attempting to perform operation (typically errors).
RetryCount contains time of operation retries
SyncOperationResult represent result of sync operation
6 nested properties
Revision holds the revision this sync operation was performed to
2 nested properties
Resources contains a list of sync result items for each individual resource in a sync operation
Revisions holds the revision this sync operation was performed for respective indexed source in sources field
ApplicationSource contains all required information about the source of an application
9 nested properties
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
ApplicationSourceDirectory holds options for applications of type plain YAML or Jsonnet
ApplicationSourceHelm holds helm specific options
ApplicationSourceKustomize holds options specific to an Application source specific to Kustomize
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
ApplicationSourcePlugin holds options specific to config management plugins
Ref is reference to another source within sources field. This field will not be used if used with a source tag.
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.
Source records the application source information of the sync, used for comparing auto-sync
Array is the value of an array type parameter.
Map is the value of a map type parameter.
OrphanedResourceKey is a reference to a resource to be ignored from
OrphanedResourcesMonitorSettings holds settings of orphaned resources monitoring
Ignore contains a list of resources that are to be excluded from orphaned resources monitoring
Warn indicates if warning condition should be created for apps which have orphaned resources
OverrideIgnoreDiff contains configurations about how fields should be ignored during diffs between the desired state and live state
JQPathExpressions is a JQ path list that will be evaludated during the diff process
JSONPointers is a JSON path list following the format defined in RFC4627 (https://datatracker.ietf.org/doc/html/rfc6902#section-3)
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 of the ConfigMap
PluginGenerator defines connection info specific to Plugin.
1 nested properties
Name of the ConfigMap
1 nested properties
Parameters contains the information to pass to the plugin. It is a map. The keys must be strings, and the values can be any type.
RequeueAfterSeconds determines how long the ApplicationSet controller will wait before reconciling the ApplicationSet again.
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
5 nested properties
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
8 nested properties
ApplicationDestination holds information about the application's destination
Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project.
IgnoreDifferences is a list of resources and their fields which should be ignored during comparison
Info contains a list of information (URLs, email addresses, and plain text) that relates to the application
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.
ApplicationSource contains all required information about the source of an application
Sources is a reference to the location of the application's manifests or chart
SyncPolicy controls when a sync will be performed in response to updates in git
Values contains key/value pairs which are passed directly as parameters to the template. These values will not be sent as parameters to the plugin.
Parameters contains the information to pass to the plugin. It is a map. The keys must be strings, and the values can be any type.
ProjectRole represents a role that has access to a project
Name is a name for this role
Description is a description of the role
Groups are a list of OIDC group claims bound to this role
JWTTokens are a list of generated JWT tokens bound to this role
Policies Stores a list of casbin formatted strings that define access policies for the role in the project
PullRequestGenerator defines a generator that scrapes a PullRequest API to find candidate pull requests.
PullRequestGeneratorAzureDevOps defines connection info specific to AzureDevOps.
6 nested properties
Azure DevOps org to scan. Required.
Azure DevOps project name to scan. Required.
Azure DevOps repo name to scan. Required.
The Azure DevOps API URL to talk to. If blank, use https://dev.azure.com/.
Labels is used to filter the PRs that you want to target
Utility struct for a reference to a secret key.
2 nested properties
PullRequestGeneratorBitbucket defines connection info specific to Bitbucket.
5 nested properties
Workspace to scan. Required.
Repo name to scan. Required.
The Bitbucket REST API URL to talk to. If blank, uses https://api.bitbucket.org/2.0.
BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.
2 nested properties
Utility struct for a reference to a secret key.
Username for Basic auth
PullRequestGeneratorBitbucketServer defines connection info specific to BitbucketServer.
4 nested properties
The Bitbucket REST API URL to talk to e.g. https://bitbucket.org/rest Required.
Project to scan. Required.
Repo name to scan. Required.
Filters for which pull requests should be considered.
PullRequestGeneratorGitea defines connection info specific to Gitea.
5 nested properties
The Gitea API URL to talk to. Required
Gitea org or user to scan. Required.
Gitea repo name to scan. Required.
Allow insecure tls, for self-signed certificates; default: false.
Utility struct for a reference to a secret key.
2 nested properties
PullRequestGenerator defines connection info specific to GitHub.
6 nested properties
GitHub org or user to scan. Required.
GitHub repo name to scan. Required.
The GitHub API URL to talk to. If blank, use https://api.github.com/.
AppSecretName is a reference to a GitHub App repo-creds secret with permission to access pull requests.
Labels is used to filter the PRs that you want to target
Utility struct for a reference to a secret key.
2 nested properties
PullRequestGeneratorGitLab defines connection info specific to GitLab.
6 nested properties
GitLab project to scan. Required.
The GitLab API URL to talk to. If blank, uses https://gitlab.com/.
Skips validating the SCM provider's TLS certificate - useful for self-signed certificates.; default: false
Labels is used to filter the MRs that you want to target
PullRequestState is an additional MRs filter to get only those with a certain state. Default: "" (all states)
Utility struct for a reference to a secret key.
2 nested properties
Standard parameters.
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
5 nested properties
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
8 nested properties
ApplicationDestination holds information about the application's destination
Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project.
IgnoreDifferences is a list of resources and their fields which should be ignored during comparison
Info contains a list of information (URLs, email addresses, and plain text) that relates to the application
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.
ApplicationSource contains all required information about the source of an application
Sources is a reference to the location of the application's manifests or chart
SyncPolicy controls when a sync will be performed in response to updates in git
PullRequestGeneratorAzureDevOps defines connection info specific to AzureDevOps.
Azure DevOps org to scan. Required.
Azure DevOps project name to scan. Required.
Azure DevOps repo name to scan. Required.
The Azure DevOps API URL to talk to. If blank, use https://dev.azure.com/.
Labels is used to filter the PRs that you want to target
Utility struct for a reference to a secret key.
2 nested properties
PullRequestGeneratorBitbucket defines connection info specific to Bitbucket.
Workspace to scan. Required.
Repo name to scan. Required.
The Bitbucket REST API URL to talk to. If blank, uses https://api.bitbucket.org/2.0.
BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.
2 nested properties
Utility struct for a reference to a secret key.
2 nested properties
Username for Basic auth
PullRequestGeneratorBitbucketServer defines connection info specific to BitbucketServer.
The Bitbucket REST API URL to talk to e.g. https://bitbucket.org/rest Required.
Project to scan. Required.
Repo name to scan. Required.
BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.
2 nested properties
Utility struct for a reference to a secret key.
2 nested properties
Username for Basic auth
PullRequestGeneratorFilter is a single pull request filter. If multiple filter types are set on a single struct, they will be AND'd together. All filters must pass for a pull request to be included.
PullRequestGeneratorGitLab defines connection info specific to GitLab.
GitLab project to scan. Required.
The GitLab API URL to talk to. If blank, uses https://gitlab.com/.
Skips validating the SCM provider's TLS certificate - useful for self-signed certificates.; default: false
Labels is used to filter the MRs that you want to target
PullRequestState is an additional MRs filter to get only those with a certain state. Default: "" (all states)
Utility struct for a reference to a secret key.
2 nested properties
PullRequestGeneratorGitea defines connection info specific to Gitea.
The Gitea API URL to talk to. Required
Gitea org or user to scan. Required.
Gitea repo name to scan. Required.
Allow insecure tls, for self-signed certificates; default: false.
Utility struct for a reference to a secret key.
2 nested properties
PullRequestGenerator defines connection info specific to GitHub.
GitHub org or user to scan. Required.
GitHub repo name to scan. Required.
The GitHub API URL to talk to. If blank, use https://api.github.com/.
AppSecretName is a reference to a GitHub App repo-creds secret with permission to access pull requests.
Labels is used to filter the PRs that you want to target
Utility struct for a reference to a secret key.
2 nested properties
Repository is a repository holding application configurations
22 nested properties
Repo contains the URL to the remote repository
ConnectionState contains information about remote resource connection state, currently used for clusters and repositories
3 nested properties
ModifiedAt contains the timestamp when this connection status has been determined
Message contains human readable information about the connection status
Status contains the current status indicator for the connection
EnableLFS specifies whether git-lfs support should be enabled for this repo. Only valid for Git repositories.
EnableOCI specifies whether helm-oci support should be enabled for this repo
ForceHttpBasicAuth specifies whether Argo CD should attempt to force basic auth for HTTP connections
GCPServiceAccountKey specifies the service account key in JSON format to be used for getting credentials to Google Cloud Source repos
GithubAppEnterpriseBaseURL specifies the base URL of GitHub Enterprise installation. If empty will default to https://api.github.com
GithubAppId specifies the ID of the GitHub app used to access the repo
GithubAppInstallationId specifies the installation ID of the GitHub App used to access the repo
Github App Private Key PEM data
Whether credentials were inherited from a credential set
Insecure specifies whether the connection to the repository ignores any errors when verifying TLS certificates or SSH host keys
InsecureIgnoreHostKey should not be used anymore, Insecure is favoured Used only for Git repos
Name specifies a name to be used for this repo. Only used with Helm repos
Password contains the password or PAT used for authenticating at the remote repository
Reference between project and repository that allow you automatically to be added as item inside SourceRepos project entity
Proxy specifies the HTTP/HTTPS proxy used to access the repo
SSHPrivateKey contains the PEM data for authenticating at the repo server. Only used with Git repos.
TLSClientCertData contains a certificate in PEM format for authenticating at the repo server
TLSClientCertKey contains a private key in PEM format for authenticating at the repo server
Type specifies the type of the repo. Can be either "git" or "helm. "git" is assumed if empty or absent.
Username contains the user name used for authenticating at the remote repository
RepoCreds holds the definition for repository credentials
URL is the URL that this credentials matches to
EnableOCI specifies whether helm-oci support should be enabled for this repo
ForceHttpBasicAuth specifies whether Argo CD should attempt to force basic auth for HTTP connections
GCPServiceAccountKey specifies the service account key in JSON format to be used for getting credentials to Google Cloud Source repos
GithubAppEnterpriseBaseURL specifies the GitHub API URL for GitHub app authentication. If empty will default to https://api.github.com
GithubAppId specifies the Github App ID of the app used to access the repo for GitHub app authentication
GithubAppInstallationId specifies the ID of the installed GitHub App for GitHub app authentication
GithubAppPrivateKey specifies the private key PEM data for authentication via GitHub app
Password for authenticating at the repo server
Proxy specifies the HTTP/HTTPS proxy used to access repos at the repo server
SSHPrivateKey contains the private key data for authenticating at the repo server using SSH (only Git repos)
TLSClientCertData specifies the TLS client cert data for authenticating at the repo server
TLSClientCertKey specifies the TLS client cert key for authenticating at the repo server
Type specifies the type of the repoCreds. Can be either "git" or "helm. "git" is assumed if empty or absent.
Username for authenticating at the repo server
RepositoryList is a collection of Repositories.
{}Repository is a repository holding application configurations
Repo contains the URL to the remote repository
ConnectionState contains information about remote resource connection state, currently used for clusters and repositories
3 nested properties
ModifiedAt contains the timestamp when this connection status has been determined
Message contains human readable information about the connection status
Status contains the current status indicator for the connection
EnableLFS specifies whether git-lfs support should be enabled for this repo. Only valid for Git repositories.
EnableOCI specifies whether helm-oci support should be enabled for this repo
ForceHttpBasicAuth specifies whether Argo CD should attempt to force basic auth for HTTP connections
GCPServiceAccountKey specifies the service account key in JSON format to be used for getting credentials to Google Cloud Source repos
GithubAppEnterpriseBaseURL specifies the base URL of GitHub Enterprise installation. If empty will default to https://api.github.com
GithubAppId specifies the ID of the GitHub app used to access the repo
GithubAppInstallationId specifies the installation ID of the GitHub App used to access the repo
Github App Private Key PEM data
Whether credentials were inherited from a credential set
Insecure specifies whether the connection to the repository ignores any errors when verifying TLS certificates or SSH host keys
InsecureIgnoreHostKey should not be used anymore, Insecure is favoured Used only for Git repos
Name specifies a name to be used for this repo. Only used with Helm repos
Password contains the password or PAT used for authenticating at the remote repository
Reference between project and repository that allow you automatically to be added as item inside SourceRepos project entity
Proxy specifies the HTTP/HTTPS proxy used to access the repo
SSHPrivateKey contains the PEM data for authenticating at the repo server. Only used with Git repos.
TLSClientCertData contains a certificate in PEM format for authenticating at the repo server
TLSClientCertKey contains a private key in PEM format for authenticating at the repo server
Type specifies the type of the repo. Can be either "git" or "helm. "git" is assumed if empty or absent.
Username contains the user name used for authenticating at the remote repository
A RepositoryCertificate is either SSH known hosts entry or TLS certificate
CertData contains the actual certificate data, dependent on the certificate type
CertInfo will hold additional certificate info, depdendent on the certificate type (e.g. SSH fingerprint, X509 CommonName)
CertSubType specifies the sub type of the cert, i.e. "ssh-rsa"
CertType specifies the type of the certificate - currently one of "https" or "ssh"
ServerName specifies the DNS name of the server this certificate is intended for
RepositoryCertificateList is a collection of RepositoryCertificates
List of certificates to be processed
{}RepositoryList is a collection of Repositories.
{}ResourceDiff holds the diff of a live and target resource object
Diff contains the JSON patch between target and live resource Deprecated: use NormalizedLiveState and PredictedLiveState to render the difference
TargetState contains the JSON live resource manifest
NormalizedLiveState contains JSON serialized live resource state with applied normalizations
PredictedLiveState contains JSON serialized resource state that is calculated based on normalized and target resource state
TargetState contains the JSON serialized resource manifest defined in the Git/Helm
ResourceIgnoreDifferences contains resource filter and list of json paths which should be ignored during comparison with live state.
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
ResourceNetworkingInfo holds networking resource related information
ExternalURLs holds list of URLs which should be available externally. List is populated for ingress resources using rules hostnames.
ResourceNode contains information about live resource and its children
HealthStatus contains information about the currently observed health state of an application or resource
2 nested properties
Message is a human-readable informational message describing the health status
Status holds the status code of the application or resource
ResourceNetworkingInfo holds networking resource related information
5 nested properties
ExternalURLs holds list of URLs which should be available externally. List is populated for ingress resources using rules hostnames.
ResourceOverride holds configuration to customize resource diffing and health assessment
OverrideIgnoreDiff contains configurations about how fields should be ignored during diffs between the desired state and live state
3 nested properties
JQPathExpressions is a JQ path list that will be evaludated during the diff process
JSONPointers is a JSON path list following the format defined in RFC4627 (https://datatracker.ietf.org/doc/html/rfc6902#section-3)
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
OverrideIgnoreDiff contains configurations about how fields should be ignored during diffs between the desired state and live state
3 nested properties
JQPathExpressions is a JQ path list that will be evaludated during the diff process
JSONPointers is a JSON path list following the format defined in RFC4627 (https://datatracker.ietf.org/doc/html/rfc6902#section-3)
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
ResourceRef includes fields which uniquely identify a resource
ResourceResult holds the operation result details of a specific resource
Group specifies the API group of the resource
Kind specifies the API kind of the resource
Name specifies the name of the resource
Namespace specifies the target namespace of the resource
Version specifies the API version of the resource
HookPhase contains the state of any operation associated with this resource OR hook This can also contain values for non-hook resources.
HookType specifies the type of the hook. Empty for non-hook resources
Message contains an informational or error message for the last sync OR operation
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 indicates the particular phase of the sync that this result was acquired in
ResourceStatus holds the current sync and health status of a resource
HealthStatus contains information about the currently observed health state of an application or resource
2 nested properties
Message is a human-readable informational message describing the health status
Status holds the status code of the application or resource
RetryStrategy contains information about the strategy to apply when a sync failed
Backoff is the backoff strategy to use on subsequent retries for failing syncs
3 nested properties
Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")
Factor is a factor to multiply the base duration after each failed retry
MaxDuration is the maximum amount of time allowed for the backoff strategy
Limit is the maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.
RevisionHistory contains history information about a previous sync
DeployedAt holds the time the sync operation completed
ID is an auto incrementing identifier of the RevisionHistory
DeployStartedAt holds the time the sync operation started
OperationInitiator contains information about the initiator of an operation
2 nested properties
Automated is set to true if operation was initiated automatically by the application controller.
Username contains the name of a user who started operation
Revision holds the revision the sync was performed against
Revisions holds the revision of each source in sources field the sync was performed against
ApplicationSource contains all required information about the source of an application
9 nested properties
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
ApplicationSourceDirectory holds options for applications of type plain YAML or Jsonnet
4 nested properties
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
ApplicationSourceJsonnet holds options specific to applications of type Jsonnet
Recurse specifies whether to scan a directory recursively for manifests
ApplicationSourceHelm holds helm specific options
10 nested properties
FileParameters are file parameters to the helm template
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
ReleaseName is the Helm release name to use. If omitted it will use the application name
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
ValuesFiles is a list of Helm value files to use when generating a template
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 specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
Version is the Helm version to use for templating ("3")
ApplicationSourceKustomize holds options specific to an Application source specific to Kustomize
14 nested properties
CommonAnnotations is a list of additional annotations to add to rendered manifests
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
CommonLabels is a list of additional labels to add to rendered manifests
Components specifies a list of kustomize components to add to the kustomization before building
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
Images is a list of Kustomize image override specifications
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
NamePrefix is a prefix appended to resources for Kustomize apps
NameSuffix is a suffix appended to resources for Kustomize apps
Namespace sets the namespace that Kustomize adds to all resources
Patches is a list of Kustomize patches
Replicas is a list of Kustomize Replicas override specifications
Version controls which version of Kustomize to use for rendering manifests
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
ApplicationSourcePlugin holds options specific to config management plugins
3 nested properties
Ref is reference to another source within sources field. This field will not be used if used with a source tag.
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 is a reference to the application sources used for the sync operation
RevisionMetadata contains metadata for a specific revision in a Git repository
Date specifies when the revision was authored
who authored this revision, typically their name and email, e.g. "John Doe [email protected]", but might not match this example
Message contains the message associated with the revision, most likely the commit message.
SignatureInfo contains a hint on the signer if the revision was signed with GPG, and signature verification is enabled.
Tags specifies any tags currently attached to the revision Floating tags can move from one revision to another
SCMProviderGenerator defines a generator that scrapes a SCMaaS API to find candidate repos.
SCMProviderGeneratorAWSCodeCommit defines connection info specific to AWS CodeCommit.
4 nested properties
Scan all branches instead of just the default branch.
Region provides the AWS region to discover repos. if not provided, AppSet controller will infer the current region from environment.
Role provides the AWS IAM role to assume, for cross-account repo discovery if not provided, AppSet controller will use its pod/node identity to discover.
TagFilters provides the tag filter(s) for repo discovery
SCMProviderGeneratorAzureDevOps defines connection info specific to Azure DevOps.
5 nested properties
Utility struct for a reference to a secret key.
2 nested properties
Azure Devops organization. Required. E.g. "my-organization".
Azure Devops team project. Required. E.g. "my-team".
Scan all branches instead of just the default branch.
The URL to Azure DevOps. If blank, use https://dev.azure.com.
SCMProviderGeneratorBitbucket defines connection info specific to Bitbucket Cloud (API version 2).
4 nested properties
Utility struct for a reference to a secret key.
2 nested properties
Bitbucket workspace to scan. Required.
Bitbucket user to use when authenticating. Should have a "member" role to be able to read all repositories and branches. Required
Scan all branches instead of just the main branch.
SCMProviderGeneratorBitbucketServer defines connection info specific to Bitbucket Server.
4 nested properties
The Bitbucket Server REST API URL to talk to. Required.
Project to scan. Required.
Scan all branches instead of just the default branch.
Which protocol to use for the SCM URL. Default is provider-specific but ssh if possible. Not all providers necessarily support all protocols.
Filters for which repos should be considered.
SCMProviderGeneratorGitea defines a connection info specific to Gitea.
5 nested properties
The Gitea URL to talk to. For example https://gitea.mydomain.com/.
Gitea organization or user to scan. Required.
Scan all branches instead of just the default branch.
Allow self-signed TLS / Certificates; default: false
Utility struct for a reference to a secret key.
2 nested properties
SCMProviderGeneratorGithub defines connection info specific to GitHub.
5 nested properties
GitHub org to scan. Required.
Scan all branches instead of just the default branch.
The GitHub API URL to talk to. If blank, use https://api.github.com/.
AppSecretName is a reference to a GitHub App repo-creds secret.
Utility struct for a reference to a secret key.
2 nested properties
SCMProviderGeneratorGitlab defines connection info specific to Gitlab.
8 nested properties
Gitlab group to scan. Required. You can use either the project id (recommended) or the full namespaced path.
Scan all branches instead of just the default branch.
The Gitlab API URL to talk to.
When recursing through subgroups, also include shared Projects (true) or scan only the subgroups under same path (false). Defaults to "true"
Recurse through subgroups (true) or scan only the base group (false). Defaults to "false"
Skips validating the SCM provider's TLS certificate - useful for self-signed certificates.; default: false
Utility struct for a reference to a secret key.
2 nested properties
Filter repos list based on Gitlab Topic.
Standard parameters.
ApplicationSetTemplate represents argocd ApplicationSpec
2 nested properties
ApplicationSetTemplateMeta represents the Argo CD application fields that may be used for Applications generated from the ApplicationSet (based on metav1.ObjectMeta)
5 nested properties
ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.
8 nested properties
ApplicationDestination holds information about the application's destination
Project is a reference to the project this application belongs to. The empty string means that application belongs to the 'default' project.
IgnoreDifferences is a list of resources and their fields which should be ignored during comparison
Info contains a list of information (URLs, email addresses, and plain text) that relates to the application
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.
ApplicationSource contains all required information about the source of an application
Sources is a reference to the location of the application's manifests or chart
SyncPolicy controls when a sync will be performed in response to updates in git
Values contains key/value pairs which are passed directly as parameters to the template
SCMProviderGeneratorAWSCodeCommit defines connection info specific to AWS CodeCommit.
Scan all branches instead of just the default branch.
Region provides the AWS region to discover repos. if not provided, AppSet controller will infer the current region from environment.
Role provides the AWS IAM role to assume, for cross-account repo discovery if not provided, AppSet controller will use its pod/node identity to discover.
TagFilters provides the tag filter(s) for repo discovery
SCMProviderGeneratorAzureDevOps defines connection info specific to Azure DevOps.
Utility struct for a reference to a secret key.
2 nested properties
Azure Devops organization. Required. E.g. "my-organization".
Azure Devops team project. Required. E.g. "my-team".
Scan all branches instead of just the default branch.
The URL to Azure DevOps. If blank, use https://dev.azure.com.
SCMProviderGeneratorBitbucket defines connection info specific to Bitbucket Cloud (API version 2).
Utility struct for a reference to a secret key.
2 nested properties
Bitbucket workspace to scan. Required.
Bitbucket user to use when authenticating. Should have a "member" role to be able to read all repositories and branches. Required
Scan all branches instead of just the main branch.
SCMProviderGeneratorBitbucketServer defines connection info specific to Bitbucket Server.
The Bitbucket Server REST API URL to talk to. Required.
Project to scan. Required.
Scan all branches instead of just the default branch.
BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.
2 nested properties
Utility struct for a reference to a secret key.
2 nested properties
Username for Basic auth
SCMProviderGeneratorFilter is a single repository filter. If multiple filter types are set on a single struct, they will be AND'd together. All filters must pass for a repo to be included.
A regex which must match the branch name.
A regex which must match at least one label.
An array of paths, all of which must not exist.
An array of paths, all of which must exist.
A regex for repo names.
SCMProviderGeneratorGitea defines a connection info specific to Gitea.
The Gitea URL to talk to. For example https://gitea.mydomain.com/.
Gitea organization or user to scan. Required.
Scan all branches instead of just the default branch.
Allow self-signed TLS / Certificates; default: false
Utility struct for a reference to a secret key.
2 nested properties
SCMProviderGeneratorGithub defines connection info specific to GitHub.
GitHub org to scan. Required.
Scan all branches instead of just the default branch.
The GitHub API URL to talk to. If blank, use https://api.github.com/.
AppSecretName is a reference to a GitHub App repo-creds secret.
Utility struct for a reference to a secret key.
2 nested properties
SCMProviderGeneratorGitlab defines connection info specific to Gitlab.
Gitlab group to scan. Required. You can use either the project id (recommended) or the full namespaced path.
Scan all branches instead of just the default branch.
The Gitlab API URL to talk to.
When recursing through subgroups, also include shared Projects (true) or scan only the subgroups under same path (false). Defaults to "true"
Recurse through subgroups (true) or scan only the base group (false). Defaults to "false"
Skips validating the SCM provider's TLS certificate - useful for self-signed certificates.; default: false
Utility struct for a reference to a secret key.
2 nested properties
Filter repos list based on Gitlab Topic.
Utility struct for a reference to a secret key.
SignatureKey is the specification of a key required to verify commit signatures with
The ID of the key in hexadecimal notation
SyncOperation contains details about a sync operation.
DryRun specifies to perform a kubectl apply --dry-run without actually performing the sync
Manifests is an optional field that overrides sync source with a local directory for development
Prune specifies to delete resources from the cluster that are no longer tracked in git
Resources describes which resources shall be part of the sync
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 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.
ApplicationSource contains all required information about the source of an application
9 nested properties
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
ApplicationSourceDirectory holds options for applications of type plain YAML or Jsonnet
4 nested properties
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
ApplicationSourceJsonnet holds options specific to applications of type Jsonnet
Recurse specifies whether to scan a directory recursively for manifests
ApplicationSourceHelm holds helm specific options
10 nested properties
FileParameters are file parameters to the helm template
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
ReleaseName is the Helm release name to use. If omitted it will use the application name
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
ValuesFiles is a list of Helm value files to use when generating a template
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 specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
Version is the Helm version to use for templating ("3")
ApplicationSourceKustomize holds options specific to an Application source specific to Kustomize
14 nested properties
CommonAnnotations is a list of additional annotations to add to rendered manifests
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
CommonLabels is a list of additional labels to add to rendered manifests
Components specifies a list of kustomize components to add to the kustomization before building
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
Images is a list of Kustomize image override specifications
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
NamePrefix is a prefix appended to resources for Kustomize apps
NameSuffix is a suffix appended to resources for Kustomize apps
Namespace sets the namespace that Kustomize adds to all resources
Patches is a list of Kustomize patches
Replicas is a list of Kustomize Replicas override specifications
Version controls which version of Kustomize to use for rendering manifests
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
ApplicationSourcePlugin holds options specific to config management plugins
3 nested properties
Ref is reference to another source within sources field. This field will not be used if used with a source tag.
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 overrides the source definition set in the application. This is typically set in a Rollback operation and is nil during a Sync operation
SyncOptions provide per-sync sync-options, e.g. Validate=false
SyncStrategy controls the manner in which a sync is performed
2 nested properties
SyncStrategyApply uses kubectl apply to perform the apply
1 nested properties
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.
SyncStrategyHook will perform a sync using hooks annotations. If no hook annotation is specified falls back to kubectl apply.
1 nested properties
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.
SyncOperationResource contains resources to sync.
SyncOperationResult represent result of sync operation
Revision holds the revision this sync operation was performed to
2 nested properties
Resources contains a list of sync result items for each individual resource in a sync operation
Revisions holds the revision this sync operation was performed for respective indexed source in sources field
ApplicationSource contains all required information about the source of an application
9 nested properties
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
ApplicationSourceDirectory holds options for applications of type plain YAML or Jsonnet
4 nested properties
Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation
Include contains a glob pattern to match paths against that should be explicitly included during manifest generation
ApplicationSourceJsonnet holds options specific to applications of type Jsonnet
Recurse specifies whether to scan a directory recursively for manifests
ApplicationSourceHelm holds helm specific options
10 nested properties
FileParameters are file parameters to the helm template
IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values
Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation
PassCredentials pass credentials to all domains (Helm's --pass-credentials)
ReleaseName is the Helm release name to use. If omitted it will use the application name
SkipCrds skips custom resource definition installation step (Helm's --skip-crds)
ValuesFiles is a list of Helm value files to use when generating a template
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 specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values.
Version is the Helm version to use for templating ("3")
ApplicationSourceKustomize holds options specific to an Application source specific to Kustomize
14 nested properties
CommonAnnotations is a list of additional annotations to add to rendered manifests
CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values
CommonLabels is a list of additional labels to add to rendered manifests
Components specifies a list of kustomize components to add to the kustomization before building
ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps
ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps
Images is a list of Kustomize image override specifications
LabelWithoutSelector specifies whether to apply common labels to resource selectors or not
NamePrefix is a prefix appended to resources for Kustomize apps
NameSuffix is a suffix appended to resources for Kustomize apps
Namespace sets the namespace that Kustomize adds to all resources
Patches is a list of Kustomize patches
Replicas is a list of Kustomize Replicas override specifications
Version controls which version of Kustomize to use for rendering manifests
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
ApplicationSourcePlugin holds options specific to config management plugins
3 nested properties
Ref is reference to another source within sources field. This field will not be used if used with a source tag.
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.
Source records the application source information of the sync, used for comparing auto-sync
SyncPolicy controls when a sync will be performed in response to updates in git
SyncPolicyAutomated controls the behavior of an automated sync
3 nested properties
AllowEmpty allows apps have zero live resources (default: false)
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 specifies whether to revert resources back to their desired state upon modification in the cluster (default: false)
2 nested properties
RetryStrategy contains information about the strategy to apply when a sync failed
2 nested properties
Backoff is the backoff strategy to use on subsequent retries for failing syncs
3 nested properties
Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")
Factor is a factor to multiply the base duration after each failed retry
MaxDuration is the maximum amount of time allowed for the backoff strategy
Limit is the maximum number of attempts for retrying a failed sync. If set to 0, no retries will be performed.
Options allow you to specify whole app sync-options
SyncPolicyAutomated controls the behavior of an automated sync
AllowEmpty allows apps have zero live resources (default: false)
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 specifies whether to revert resources back to their desired state upon modification in the cluster (default: false)
SyncStatus contains information about the currently observed live and desired states of an application
Status is the sync state of the comparison
ComparedTo contains application source and target which was used for resources comparison
4 nested properties
ApplicationDestination holds information about the application's destination
3 nested properties
Name is an alternate way of specifying the target cluster by its symbolic name. This must be set if Server is not set.
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 specifies the URL of the target cluster's Kubernetes control plane API. This must be set if Name is not set.
IgnoreDifferences is a reference to the application's ignored differences used for comparison
ApplicationSource contains all required information about the source of an application
9 nested properties
RepoURL is the URL to the repository (Git or Helm) that contains the application manifests
Chart is a Helm chart name, and must be specified for applications sourced from a Helm repo.
ApplicationSourceDirectory holds options for applications of type plain YAML or Jsonnet
ApplicationSourceHelm holds helm specific options
ApplicationSourceKustomize holds options specific to an Application source specific to Kustomize
Path is a directory path within the Git repository, and is only valid for applications sourced from Git.
ApplicationSourcePlugin holds options specific to config management plugins
Ref is reference to another source within sources field. This field will not be used if used with a source tag.
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 is a reference to the application's multiple sources used for comparison
Revision contains information about the revision the comparison has been performed to
Revisions contains information about the revisions of multiple sources the comparison has been performed to
SyncStrategy controls the manner in which a sync is performed
SyncStrategyApply uses kubectl apply to perform the apply
1 nested properties
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.
SyncStrategyHook will perform a sync using hooks annotations. If no hook annotation is specified falls back to kubectl apply.
1 nested properties
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.
SyncStrategyApply uses kubectl apply to perform the apply
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.
SyncStrategyHook will perform a sync using hooks annotations. If no hook annotation is specified falls back to kubectl apply.
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.
SyncWindow contains the kind, time, duration and attributes that are used to assign the syncWindows to apps
Applications contains a list of applications that the window will apply to
Clusters contains a list of clusters that the window will apply to
Duration is the amount of time the sync window will be open
Kind defines if the window allows or blocks syncs
ManualSync enables manual syncs when they would otherwise be blocked
Namespaces contains a list of namespaces that the window will apply to
Schedule is the time the window will begin, specified in cron format
TimeZone of the sync that will be applied to the schedule
TLSClientConfig contains settings to enable transport layer security
Insecure specifies that the server should be accessed without verifying the TLS certificate. For testing only.
CAData holds PEM-encoded bytes (typically read from a root certificates bundle). CAData takes precedence over CAFile
CertData holds PEM-encoded bytes (typically read from a client certificate file). CertData takes precedence over CertFile
KeyData holds PEM-encoded bytes (typically read from a client certificate key file). KeyData takes precedence over KeyFile
ServerName is passed to the server for SNI and is used in the client to check server certificates against. If ServerName is empty, the hostname used to contact the server is used.