ApplicationSetService

/api/v1/stream/applicationsets

GET
https://argocd.example.com/api/v1/stream/applicationsets

Parameters

namestringquery
projectsArray<string>query
selectorstringquery
appSetNamespacestringquery
resourceVersionstringquery

when specified with a watch call, shows changes that occur after that particular version of a resource.

Response

200OKobject

A successful response.(streaming responses)

Response fields application/json
errorruntimeStreamError
Show child attributes
detailsArray<protobufAny>
Show child attributes
type_urlstring
valuestring<byte>
grpc_codeinteger<int32>
http_codeinteger<int32>
http_statusstring
messagestring
resultv1alpha1ApplicationSetWatchEvent

ApplicationSetWatchEvent contains information about application change.

Show child attributes
applicationSetv1alpha1ApplicationSet
Show child attributes
metadatav1ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Show child attributes
annotationsobject
Show child attributes
[key: string]string
creationTimestampv1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

deletionGracePeriodSecondsinteger<int64>
deletionTimestampv1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

finalizersArray<string>
generateNamestring

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

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

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

generationinteger<int64>
labelsobject
Show child attributes
[key: string]string
managedFieldsArray<v1ManagedFieldsEntry>

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

+optional +listType=atomic +k8s:alpha(since: "1.37")=+k8s:optional

Show child attributes

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

apiVersionstring

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

fieldsTypestring
fieldsV1v1FieldsV1

FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.

Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.

The exact format is defined in sigs.k8s.io/structured-merge-diff +k8s:deepcopy-gen=false +protobuf.options.marshal=false +protobuf.options.(gogoproto.goproto_stringer)=false

Show child attributes
Rawstring<byte>

Raw is the underlying serialization of this object.

Deprecated: Direct access to this field is deprecated. Use GetRawBytes, GetRawString, SetRawBytes, SetRawString, GetRawReader, NewFieldsV1 instead.

managerstring

Manager is an identifier of the workflow managing these fields.

operationstring
subresourcestring

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

timev1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

namestring
namespacestring

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

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

ownerReferencesArray<v1OwnerReference>
Show child attributes
apiVersionstring
blockOwnerDeletionboolean
controllerboolean
kindstring
namestring
uidstring
resourceVersionstring

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

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

uidstring

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

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids +optional +k8s:alpha(since: "1.37")=+k8s:optional +k8s:alpha(since: "1.37")=+k8s:immutable

specv1alpha1ApplicationSetSpec

ApplicationSetSpec represents a class of application set state.

Show child attributes
applyNestedSelectorsboolean

ApplyNestedSelectors enables selectors defined within the generators of two level-nested matrix or merge generators.

Deprecated: This field is ignored, and the behavior is always enabled. The field will be removed in a future version of the ApplicationSet CRD.

generatorsArray<v1alpha1ApplicationSetGenerator>
Show child attributes

ApplicationSetGenerator represents a generator at the top level of an ApplicationSet.

clusterDecisionResourcev1alpha1DuckTypeGenerator

DuckType defines a generator to match against clusters registered with ArgoCD.

Show child attributes
configMapRefstring
namestring
requeueAfterSecondsinteger<int64>
valuesobject
Show child attributes
[key: string]string
clustersv1alpha1ClusterGenerator

ClusterGenerator defines a generator to match against clusters registered with ArgoCD.

Show child attributes
flatListboolean
valuesobject
Show child attributes
[key: string]string
gitv1alpha1GitGenerator
Show child attributes
directoriesArray<v1alpha1GitDirectoryGeneratorItem>
Show child attributes
excludeboolean
pathstring
filesArray<v1alpha1GitFileGeneratorItem>
Show child attributes
excludeboolean
pathstring
pathParamPrefixstring
repoURLstring
requeueAfterSecondsinteger<int64>
revisionstring
valuesobject
Show child attributes
[key: string]string
listv1alpha1ListGenerator
Show child attributes
elementsArray<v1JSON>
Show child attributes

JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.

rawstring<byte>
elementsYamlstring
matrixv1alpha1MatrixGenerator

MatrixGenerator generates the cartesian product of two sets of parameters. The parameters are defined by two nested generators.

Show child attributes
generatorsArray<v1alpha1ApplicationSetNestedGenerator>
Show child attributes

ApplicationSetNestedGenerator represents a generator nested within a combination-type generator (MatrixGenerator or MergeGenerator).

clusterDecisionResourcev1alpha1DuckTypeGenerator

DuckType defines a generator to match against clusters registered with ArgoCD.

Same fields as result.applicationSet.spec.generators.clusterDecisionResource

clustersv1alpha1ClusterGenerator

ClusterGenerator defines a generator to match against clusters registered with ArgoCD.

Same fields as result.applicationSet.spec.generators.clusters

matrixv1JSON

JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.

Same fields as result.applicationSet.spec.generators.list.elements

mergev1JSON

JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.

Same fields as result.applicationSet.spec.generators.list.elements

pluginv1alpha1PluginGenerator

PluginGenerator defines connection info specific to Plugin.

Same fields as result.applicationSet.spec.generators.plugin

pullRequestv1alpha1PullRequestGenerator

PullRequestGenerator defines a generator that scrapes a PullRequest API to find candidate pull requests.

Same fields as result.applicationSet.spec.generators.pullRequest

scmProviderv1alpha1SCMProviderGenerator

SCMProviderGenerator defines a generator that scrapes a SCMaaS API to find candidate repos.

Same fields as result.applicationSet.spec.generators.scmProvider

mergev1alpha1MergeGenerator

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.

Show child attributes
mergeKeysArray<string>
ociv1alpha1OciGenerator
Show child attributes
directoriesArray<v1alpha1OciDirectoryGeneratorItem>
Show child attributes
excludeboolean
pathstring
filesArray<v1alpha1OciFileGeneratorItem>
Show child attributes
excludeboolean
pathstring
pathParamPrefixstring
repoURLstring
requeueAfterSecondsinteger<int64>
revisionstring
valuesobject
Show child attributes
[key: string]string
pluginv1alpha1PluginGenerator

PluginGenerator defines connection info specific to Plugin.

Show child attributes
configMapRefv1alpha1PluginConfigMapRef
Show child attributes
namestring
inputv1alpha1PluginInput
Show child attributes
parametersobject

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.

Show child attributes
[key: string]v1JSON

JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.

Same fields as result.applicationSet.spec.generators.list.elements

requeueAfterSecondsinteger<int64>

RequeueAfterSeconds determines how long the ApplicationSet controller will wait before reconciling the ApplicationSet again.

valuesobject

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.

Show child attributes
[key: string]string
pullRequestv1alpha1PullRequestGenerator

PullRequestGenerator defines a generator that scrapes a PullRequest API to find candidate pull requests.

Show child attributes
azuredevopsv1alpha1PullRequestGeneratorAzureDevOps

PullRequestGeneratorAzureDevOps defines connection info specific to AzureDevOps.

Show child attributes
apistring

The Azure DevOps API URL to talk to. If blank, use https://dev.azure.com/.

labelsArray<string>
organizationstring

Azure DevOps org to scan. Required.

projectstring

Azure DevOps project name to scan. Required.

repostring

Azure DevOps repo name to scan. Required.

tokenRefv1alpha1SecretRef

SecretRef struct for a reference to a secret key.

Show child attributes
keystring
secretNamestring
bitbucketv1alpha1PullRequestGeneratorBitbucket

PullRequestGeneratorBitbucket defines connection info specific to Bitbucket.

Show child attributes
apistring

The Bitbucket REST API URL to talk to. If blank, uses https://api.bitbucket.org/2.0.

basicAuthv1alpha1BasicAuthBitbucketServer

BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.

Show child attributes
passwordRefv1alpha1SecretRef

SecretRef struct for a reference to a secret key.

Same fields as result.applicationSet.spec.generators.pullRequest.azuredevops.tokenRef

usernamestring
bearerTokenv1alpha1BearerTokenBitbucketCloud

BearerTokenBitbucketCloud defines the Bearer token for BitBucket AppToken auth.

Show child attributes
tokenRefv1alpha1SecretRef

SecretRef struct for a reference to a secret key.

Same fields as result.applicationSet.spec.generators.pullRequest.azuredevops.tokenRef

ownerstring

Workspace to scan. Required.

repostring

Repo name to scan. Required.

bitbucketServerv1alpha1PullRequestGeneratorBitbucketServer

PullRequestGeneratorBitbucketServer defines connection info specific to BitbucketServer.

Show child attributes
apistring

The Bitbucket REST API URL to talk to e.g. https://bitbucket.org/rest Required.

basicAuthv1alpha1BasicAuthBitbucketServer

BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.

Same fields as result.applicationSet.spec.generators.pullRequest.bitbucket.basicAuth

bearerTokenv1alpha1BearerTokenBitbucket

BearerTokenBitbucket defines the Bearer token for BitBucket AppToken auth.

Show child attributes
tokenRefv1alpha1SecretRef

SecretRef struct for a reference to a secret key.

Same fields as result.applicationSet.spec.generators.pullRequest.azuredevops.tokenRef

caRefv1alpha1ConfigMapKeyRef

ConfigMapKeyRef struct for a reference to a configmap key.

Show child attributes
configMapNamestring
keystring
insecureboolean
projectstring

Project to scan. Required.

repostring

Repo name to scan. Required.

continueOnRepoNotFoundErrorboolean

ContinueOnRepoNotFoundError is a flag to continue the ApplicationSet Pull Request generator parameters generation even if the repository is not found.

filtersArray<v1alpha1PullRequestGeneratorFilter>

Filters for which pull requests should be considered.

Show child attributes

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.

branchMatchstring
targetBranchMatchstring
titleMatchstring
giteav1alpha1PullRequestGeneratorGitea

PullRequestGeneratorGitea defines connection info specific to Gitea.

Show child attributes
apistring
insecureboolean

Allow insecure tls, for self-signed certificates; default: false.

labelsArray<string>
ownerstring

Gitea org or user to scan. Required.

repostring

Gitea repo name to scan. Required.

tokenRefv1alpha1SecretRef

SecretRef struct for a reference to a secret key.

Same fields as result.applicationSet.spec.generators.pullRequest.azuredevops.tokenRef

githubv1alpha1PullRequestGeneratorGithub

PullRequestGeneratorGithub defines connection info specific to GitHub.

Show child attributes
apistring

The GitHub API URL to talk to. If blank, use https://api.github.com/.

appSecretNamestring

AppSecretName is a reference to a GitHub App repo-creds secret with permission to access pull requests.

labelsArray<string>
ownerstring

GitHub org or user to scan. Required.

repostring

GitHub repo name to scan. Required.

tokenRefv1alpha1SecretRef

SecretRef struct for a reference to a secret key.

Same fields as result.applicationSet.spec.generators.pullRequest.azuredevops.tokenRef

gitlabv1alpha1PullRequestGeneratorGitLab

PullRequestGeneratorGitLab defines connection info specific to GitLab.

Show child attributes
apistring

The GitLab API URL to talk to. If blank, uses https://gitlab.com/.

caRefv1alpha1ConfigMapKeyRef

ConfigMapKeyRef struct for a reference to a configmap key.

Same fields as result.applicationSet.spec.generators.pullRequest.bitbucketServer.caRef

insecureboolean
labelsArray<string>
projectstring

GitLab project to scan. Required.

pullRequestStatestring

PullRequestState is an additional MRs filter to get only those with a certain state. Default: "" (all states). Valid values: opened, closed, merged, locked".

tokenRefv1alpha1SecretRef

SecretRef struct for a reference to a secret key.

Same fields as result.applicationSet.spec.generators.pullRequest.azuredevops.tokenRef

requeueAfterSecondsinteger<int64>

Standard parameters.

valuesobject
Show child attributes
[key: string]string
scmProviderv1alpha1SCMProviderGenerator

SCMProviderGenerator defines a generator that scrapes a SCMaaS API to find candidate repos.

Show child attributes
awsCodeCommitv1alpha1SCMProviderGeneratorAWSCodeCommit

SCMProviderGeneratorAWSCodeCommit defines connection info specific to AWS CodeCommit.

Show child attributes
allBranchesboolean

Scan all branches instead of just the default branch.

regionstring

Region provides the AWS region to discover repos. if not provided, AppSet controller will infer the current region from environment.

rolestring

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.

tagFiltersArray<v1alpha1TagFilter>
Show child attributes
keystring
valuestring
azureDevOpsv1alpha1SCMProviderGeneratorAzureDevOps

SCMProviderGeneratorAzureDevOps defines connection info specific to Azure DevOps.

Show child attributes
accessTokenRefv1alpha1SecretRef

SecretRef struct for a reference to a secret key.

Same fields as result.applicationSet.spec.generators.pullRequest.azuredevops.tokenRef

allBranchesboolean

Scan all branches instead of just the default branch.

apistring

The URL to Azure DevOps. If blank, use https://dev.azure.com.

organizationstring

Azure Devops organization. Required. E.g. "my-organization".

teamProjectstring

Azure Devops team project. Required. E.g. "my-team".

bitbucketv1alpha1SCMProviderGeneratorBitbucket

SCMProviderGeneratorBitbucket defines connection info specific to Bitbucket Cloud (API version 2).

Show child attributes
allBranchesboolean

Scan all branches instead of just the main branch.

appPasswordRefv1alpha1SecretRef

SecretRef struct for a reference to a secret key.

Same fields as result.applicationSet.spec.generators.pullRequest.azuredevops.tokenRef

ownerstring

Bitbucket workspace to scan. Required.

userstring
bitbucketServerv1alpha1SCMProviderGeneratorBitbucketServer

SCMProviderGeneratorBitbucketServer defines connection info specific to Bitbucket Server.

Show child attributes
allBranchesboolean

Scan all branches instead of just the default branch.

apistring

The Bitbucket Server REST API URL to talk to. Required.

basicAuthv1alpha1BasicAuthBitbucketServer

BasicAuthBitbucketServer defines the username/(password or personal access token) for Basic auth.

Same fields as result.applicationSet.spec.generators.pullRequest.bitbucket.basicAuth

bearerTokenv1alpha1BearerTokenBitbucket

BearerTokenBitbucket defines the Bearer token for BitBucket AppToken auth.

Same fields as result.applicationSet.spec.generators.pullRequest.bitbucketServer.bearerToken

caRefv1alpha1ConfigMapKeyRef

ConfigMapKeyRef struct for a reference to a configmap key.

Same fields as result.applicationSet.spec.generators.pullRequest.bitbucketServer.caRef

insecureboolean
projectstring

Project to scan. Required.

cloneProtocolstring

Which protocol to use for the SCM URL. Default is provider-specific but ssh if possible. Not all providers necessarily support all protocols.

filtersArray<v1alpha1SCMProviderGeneratorFilter>

Filters for which repos should be considered.

Show child attributes

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.

branchMatchstring

A regex which must match the branch name.

labelMatchstring

A regex which must match at least one label.

pathsDoNotExistArray<string>

An array of paths, all of which must not exist.

pathsExistArray<string>

An array of paths, all of which must exist.

repositoryMatchstring

A regex for repo names.

giteav1alpha1SCMProviderGeneratorGitea

SCMProviderGeneratorGitea defines a connection info specific to Gitea.

Show child attributes
allBranchesboolean

Scan all branches instead of just the default branch.

apistring

The Gitea URL to talk to. For example https://gitea.mydomain.com/.

excludeArchivedReposboolean

Exclude repositories that are archived.

insecureboolean
ownerstring

Gitea organization or user to scan. Required.

tokenRefv1alpha1SecretRef

SecretRef struct for a reference to a secret key.

Same fields as result.applicationSet.spec.generators.pullRequest.azuredevops.tokenRef

githubv1alpha1SCMProviderGeneratorGithub

SCMProviderGeneratorGithub defines connection info specific to GitHub.

Show child attributes
allBranchesboolean

Scan all branches instead of just the default branch.

apistring

The GitHub API URL to talk to. If blank, use https://api.github.com/.

appSecretNamestring

AppSecretName is a reference to a GitHub App repo-creds secret.

excludeArchivedReposboolean

Exclude repositories that are archived.

organizationstring

GitHub org to scan. Required.

tokenRefv1alpha1SecretRef

SecretRef struct for a reference to a secret key.

Same fields as result.applicationSet.spec.generators.pullRequest.azuredevops.tokenRef

gitlabv1alpha1SCMProviderGeneratorGitlab

SCMProviderGeneratorGitlab defines connection info specific to Gitlab.

Show child attributes
allBranchesboolean

Scan all branches instead of just the default branch.

apistring

The Gitlab API URL to talk to.

caRefv1alpha1ConfigMapKeyRef

ConfigMapKeyRef struct for a reference to a configmap key.

Same fields as result.applicationSet.spec.generators.pullRequest.bitbucketServer.caRef

groupstring

Gitlab group to scan. Required. You can use either the project id (recommended) or the full namespaced path.

includeArchivedReposboolean

Include repositories that are archived.

includeSharedProjectsboolean
includeSubgroupsboolean
insecureboolean
tokenRefv1alpha1SecretRef

SecretRef struct for a reference to a secret key.

Same fields as result.applicationSet.spec.generators.pullRequest.azuredevops.tokenRef

topicstring

Filter repos list based on Gitlab Topic.

requeueAfterSecondsinteger<int64>

Standard parameters.

valuesobject
Show child attributes
[key: string]string
selectorv1LabelSelector
Show child attributes
matchExpressionsArray<v1LabelSelectorRequirement>
Show child attributes

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

keystring

key is the label key that the selector applies to.

operatorstring

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

valuesArray<string>
matchLabelsobject
Show child attributes
[key: string]string
goTemplateboolean
goTemplateOptionsArray<string>
ignoreApplicationDifferencesArray<v1alpha1ApplicationSetResourceIgnoreDifferences>
Show child attributes

ApplicationSetResourceIgnoreDifferences configures how the ApplicationSet controller will ignore differences in live applications when applying changes from generated applications.

jqPathExpressionsArray<string>

JQPathExpressions is a list of JQ path expressions to fields to ignore differences for.

jsonPointersArray<string>

JSONPointers is a list of JSON pointers to fields to ignore differences for.

namestring

Name is the name of the application to ignore differences for. If not specified, the rule applies to all applications.

preservedFieldsv1alpha1ApplicationPreservedFields
Show child attributes
annotationsArray<string>
labelsArray<string>
strategyv1alpha1ApplicationSetStrategy

ApplicationSetStrategy configures how generated Applications are updated in sequence.

Show child attributes
deletionOrderstring
rollingSyncv1alpha1ApplicationSetRolloutStrategy
Show child attributes
stepsArray<v1alpha1ApplicationSetRolloutStep>
Show child attributes
matchExpressionsArray<v1alpha1ApplicationMatchExpression>
Show child attributes
keystring
operatorstring
valuesArray<string>
maxUpdateintstrIntOrString

+protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true +k8s:openapi-model-package=io.k8s.apimachinery.pkg.util.intstr

Show child attributes
intValinteger<int32>
strValstring
typeinteger<int64>
typestring
syncPolicyv1alpha1ApplicationSetSyncPolicy

ApplicationSetSyncPolicy configures how generated Applications will relate to their ApplicationSet.

Show child attributes
applicationsSyncstring
preserveResourcesOnDeletionboolean

PreserveResourcesOnDeletion will preserve resources on deletion. If PreserveResourcesOnDeletion is set to true, these Applications will not be deleted.

templatev1alpha1ApplicationSetTemplate
Show child attributes
metadatav1alpha1ApplicationSetTemplateMeta
Show child attributes
annotationsobject
Show child attributes
[key: string]string
finalizersArray<string>
labelsobject
Show child attributes
[key: string]string
namestring
namespacestring
specv1alpha1ApplicationSpec

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

Show child attributes
destinationv1alpha1ApplicationDestination
Show child attributes
namestring

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

namespacestring
serverstring

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

ignoreDifferencesArray<v1alpha1ResourceIgnoreDifferences>
Show child attributes

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

groupstring
jqPathExpressionsArray<string>
jsonPointersArray<string>
kindstring
managedFieldsManagersArray<string>
namestring
namespacestring
infoArray<v1alpha1Info>
Show child attributes
namestring
valuestring
projectstring

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

revisionHistoryLimitinteger<int64>

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

sourcev1alpha1ApplicationSource
Show child attributes
chartstring

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

directoryv1alpha1ApplicationSourceDirectory
Show child attributes
disableExtensionFilterboolean

DisableExtensionFilter controls whether the built-in file-extension filter is skipped during manifest generation. When false (the default), only files with a .yaml, .yml, .json, or .jsonnet extension are considered as potential manifests. Set it to true to disable the filter so that files with custom extensions (e.g. *.yaml.sealed) can be matched by the include/exclude glob patterns instead.

excludestring
includestring
jsonnetv1alpha1ApplicationSourceJsonnet
Show child attributes
extVarsArray<v1alpha1JsonnetVar>
Show child attributes
codeboolean
namestring
valuestring
libsArray<string>
recurseboolean
helmv1alpha1ApplicationSourceHelm
Show child attributes
apiVersionsArray<string>

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

fileParametersArray<v1alpha1HelmFileParameter>
Show child attributes
namestring
pathstring
ignoreMissingValueFilesboolean
kubeVersionstring

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

namespacestring

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

parametersArray<v1alpha1HelmParameter>
Show child attributes
forceStringboolean
namestring
valuestring
passCredentialsboolean
releaseNamestring
skipCrdsboolean
skipSchemaValidationboolean
skipTestsboolean

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

valueFilesArray<string>
valuesstring
valuesObjectruntimeRawExtension

RawExtension is used to hold extensions in external versions.

To use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.

// Internal package:

type MyAPIObject struct {
	runtime.TypeMeta `json:""`
	MyPlugin runtime.Object `json:"myPlugin"`
}

type PluginA struct {
	AOption string `json:"aOption"`
}

// External package:

type MyAPIObject struct {
	runtime.TypeMeta `json:""`
	MyPlugin runtime.RawExtension `json:"myPlugin"`
}

type PluginA struct {
	AOption string `json:"aOption"`
}

// On the wire, the JSON will look something like this:

{
	"kind":"MyAPIObject",
	"apiVersion":"v1",
	"myPlugin": {
		"kind":"PluginA",
		"aOption":"foo",
	},
}

So what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)

+k8s:deepcopy-gen=true +protobuf=true +k8s:openapi-gen=true

Show child attributes
rawstring<byte>

Raw is the underlying serialization of this object.

TODO: Determine how to detect ContentType and ContentEncoding of 'Raw' data.

versionstring
kustomizev1alpha1ApplicationSourceKustomize
Show child attributes
apiVersionsArray<string>

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

commonAnnotationsobject
Show child attributes
[key: string]string
commonAnnotationsEnvsubstboolean
commonLabelsobject
Show child attributes
[key: string]string
componentsArray<string>
forceCommonAnnotationsboolean
forceCommonLabelsboolean
ignoreMissingComponentsboolean
imagesArray<string>
kubeVersionstring

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

labelIncludeTemplatesboolean
labelWithoutSelectorboolean
namePrefixstring
nameSuffixstring
namespacestring
patchesArray<v1alpha1KustomizePatch>
Show child attributes
optionsobject
Show child attributes
[key: string]boolean
patchstring
pathstring
targetv1alpha1KustomizeSelector
Show child attributes
annotationSelectorstring
labelSelectorstring
resIdv1alpha1KustomizeResId
Show child attributes
gvkv1alpha1KustomizeGvk
Show child attributes
groupstring
kindstring
versionstring
namestring
namespacestring
replicasArray<v1alpha1KustomizeReplica>
Show child attributes
countintstrIntOrString

+protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true +k8s:openapi-model-package=io.k8s.apimachinery.pkg.util.intstr

Same fields as result.applicationSet.spec.strategy.rollingSync.steps.maxUpdate

namestring
versionstring
namestring

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

pathstring

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

pluginv1alpha1ApplicationSourcePlugin
Show child attributes
envArray<applicationv1alpha1EnvEntry>
Show child attributes
namestring
valuestring
namestring
parametersArray<v1alpha1ApplicationSourcePluginParameter>
Show child attributes
arrayArray<string>

Array is the value of an array type parameter.

mapobject

Map is the value of a map type parameter.

Show child attributes
[key: string]string
namestring

Name is the name identifying a parameter.

stringstring

String_ is the value of a string type parameter.

refstring

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

repoURLstring
tagPrefixstring

TagPrefix filters git tags to only those with this prefix before evaluating targetRevision as a semver constraint. The prefix is stripped from tag names before comparison and re-added to the resolved version. For example, with tagPrefix "component-b/" and targetRevision "1.0.*", tags like "component-b/1.0.0" and "component-b/1.0.1" are candidates, and the constraint resolves to "component-b/1.0.1".

targetRevisionstring

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.

sourceHydratorv1alpha1SourceHydrator

SourceHydrator specifies a dry "don't repeat yourself" source for manifests, a sync source from which to sync hydrated manifests, and an optional hydrateTo location to act as a "staging" aread for hydrated manifests.

Show child attributes
drySourcev1alpha1DrySource

DrySource specifies a location for dry "don't repeat yourself" manifest source information.

Show child attributes
pathstring
repoURLstring
targetRevisionstring
hydrateTov1alpha1HydrateTo

HydrateTo specifies a branch to which hydrated manifests should be pushed as a "staging area" before being moved to the SyncSource. The repository and path are inherited from SyncSource.

Show child attributes
targetBranchstring
syncSourcev1alpha1SyncSource

SyncSource specifies a location from which hydrated manifests may be synced. If RepoURL is not set, it is assumed to be the same as the associated DrySource config in the SourceHydrator.

Show child attributes
pathstring

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

+kubebuilder:validation:Required +kubebuilder:validation:MinLength=1 +kubebuilder:validation:Pattern=^.{2,}|[^./]$

repoURLstring

RepoURL is the URL to the git repository that contains the hydrated manifests. If not set, defaults to the DrySource.RepoURL.

targetBranchstring

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

syncPolicyv1alpha1SyncPolicy
Show child attributes
automatedv1alpha1SyncPolicyAutomated
Show child attributes
allowEmptyboolean
enabledboolean
pruneboolean
selfHealboolean
managedNamespaceMetadatav1alpha1ManagedNamespaceMetadata
Show child attributes
annotationsobject
Show child attributes
[key: string]string
labelsobject
Show child attributes
[key: string]string
retryv1alpha1RetryStrategy
Show child attributes
backoffv1alpha1Backoff
Show child attributes
durationstring
factorinteger<int64>
maxDurationstring
limitinteger<int64>

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

refreshboolean
syncOptionsArray<string>
templatePatchstring
statusv1alpha1ApplicationSetStatus
Show child attributes
applicationStatusArray<v1alpha1ApplicationSetApplicationStatus>
Show child attributes
applicationstring
lastTransitionTimev1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

messagestring
statusstring
stepstring
targetrevisionsArray<string>

TargetRevision tracks the desired revisions the Application should be synced to.

conditionsArray<v1alpha1ApplicationSetCondition>
Show child attributes
lastTransitionTimev1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

messagestring
reasonstring
statusstring
typestring
healthv1alpha1HealthStatus
Show child attributes
lastTransitionTimev1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

messagestring
statusstring
resourcesArray<applicationv1alpha1ResourceStatus>

Resources is a list of Applications resources managed by this application set.

Show child attributes

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

groupstring

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

hookboolean

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

kindstring

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

namestring

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

namespacestring

Namespace defines the Kubernetes namespace where the resource is located.

requiresDeletionConfirmationboolean

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

requiresPruningboolean

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

statusstring

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

syncWaveinteger<int64>

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

versionstring

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

resourcesCountinteger<int64>

ResourcesCount is the total number of resources managed by this application set. The count may be higher than actual number of items in the Resources field when the number of managed resources exceeds the limit imposed by the controller (to avoid making the status field too large).

typestring
defaultruntimeError

An unexpected error response.

Response fields application/json
codeinteger<int32>
detailsArray<protobufAny>
Show child attributes
type_urlstring
valuestring<byte>
errorstring
messagestring

Authorization

bearerapiKey in header

A token sent as Authorization: Bearer <token>. API Docs shows how to get one.

Docs by Sourcey
↑↓ navigate↵ selectesc close