Skip to content

argoproj.v1alpha1.application

"Application is a definition of Application resource."

Index

Fields

fn new

new(name)

new returns an instance of Application

obj metadata

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

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"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."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"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."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"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.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"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.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"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.\n\nPopulated 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"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"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.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj operation

"Operation contains information about a requested or running operation"

fn operation.withInfo

withInfo(info)

"Info is a list of informational items for this operation"

fn operation.withInfoMixin

withInfoMixin(info)

"Info is a list of informational items for this operation"

Note: This function appends passed data to existing values

obj operation.info

"Info is a list of informational items for this operation"

fn operation.info.withName

withName(name)

fn operation.info.withValue

withValue(value)

obj operation.initiatedBy

"InitiatedBy contains information about who initiated the operations"

fn operation.initiatedBy.withAutomated

withAutomated(automated)

"Automated is set to true if operation was initiated automatically by the application controller."

fn operation.initiatedBy.withUsername

withUsername(username)

"Username contains the name of a user who started operation"

obj operation.retry

"Retry controls the strategy to apply if a sync fails"

fn operation.retry.withLimit

withLimit(limit)

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

obj operation.retry.backoff

"Backoff controls how to backoff on subsequent retries of failed syncs"

fn operation.retry.backoff.withDuration

withDuration(duration)

"Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. \"2m\", \"1h\")"

fn operation.retry.backoff.withFactor

withFactor(factor)

"Factor is a factor to multiply the base duration after each failed retry"

fn operation.retry.backoff.withMaxDuration

withMaxDuration(maxDuration)

"MaxDuration is the maximum amount of time allowed for the backoff strategy"

obj operation.sync

"Sync contains parameters for the operation"

fn operation.sync.withAutoHealAttemptsCount

withAutoHealAttemptsCount(autoHealAttemptsCount)

"SelfHealAttemptsCount contains the number of auto-heal attempts"

fn operation.sync.withDryRun

withDryRun(dryRun)

"DryRun specifies to perform a kubectl apply --dry-run without actually performing the sync"

fn operation.sync.withManifests

withManifests(manifests)

"Manifests is an optional field that overrides sync source with a local directory for development"

fn operation.sync.withManifestsMixin

withManifestsMixin(manifests)

"Manifests is an optional field that overrides sync source with a local directory for development"

Note: This function appends passed data to existing values

fn operation.sync.withPrune

withPrune(prune)

"Prune specifies to delete resources from the cluster that are no longer tracked in git"

fn operation.sync.withResources

withResources(resources)

"Resources describes which resources shall be part of the sync"

fn operation.sync.withResourcesMixin

withResourcesMixin(resources)

"Resources describes which resources shall be part of the sync"

Note: This function appends passed data to existing values

fn operation.sync.withRevision

withRevision(revision)

"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."

fn operation.sync.withRevisions

withRevisions(revisions)

"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."

fn operation.sync.withRevisionsMixin

withRevisionsMixin(revisions)

"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."

Note: This function appends passed data to existing values

fn operation.sync.withSources

withSources(sources)

"Sources overrides the source definition set in the application. This is typically set in a Rollback operation and is nil during a Sync operation"

fn operation.sync.withSourcesMixin

withSourcesMixin(sources)

"Sources overrides the source definition set in the application. This is typically set in a Rollback operation and is nil during a Sync operation"

Note: This function appends passed data to existing values

fn operation.sync.withSyncOptions

withSyncOptions(syncOptions)

"SyncOptions provide per-sync sync-options, e.g. Validate=false"

fn operation.sync.withSyncOptionsMixin

withSyncOptionsMixin(syncOptions)

"SyncOptions provide per-sync sync-options, e.g. Validate=false"

Note: This function appends passed data to existing values

obj operation.sync.resources

"Resources describes which resources shall be part of the sync"

fn operation.sync.resources.withGroup

withGroup(group)

fn operation.sync.resources.withKind

withKind(kind)

fn operation.sync.resources.withName

withName(name)

fn operation.sync.resources.withNamespace

withNamespace(namespace)

obj operation.sync.source

"Source overrides the source definition set in the application. This is typically set in a Rollback operation and is nil during a Sync operation"

fn operation.sync.source.withChart

withChart(chart)

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

fn operation.sync.source.withPath

withPath(path)

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

fn operation.sync.source.withRef

withRef(ref)

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

fn operation.sync.source.withRepoURL

withRepoURL(repoURL)

"RepoURL is the URL to the repository (Git or Helm) that contains the application manifests"

fn operation.sync.source.withTargetRevision

withTargetRevision(targetRevision)

"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."

obj operation.sync.source.directory

"Directory holds path/directory specific options"

fn operation.sync.source.directory.withExclude

withExclude(exclude)

"Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation"

fn operation.sync.source.directory.withInclude

withInclude(include)

"Include contains a glob pattern to match paths against that should be explicitly included during manifest generation"

fn operation.sync.source.directory.withRecurse

withRecurse(recurse)

"Recurse specifies whether to scan a directory recursively for manifests"

obj operation.sync.source.directory.jsonnet

"Jsonnet holds options specific to Jsonnet"

fn operation.sync.source.directory.jsonnet.withExtVars

withExtVars(extVars)

"ExtVars is a list of Jsonnet External Variables"

fn operation.sync.source.directory.jsonnet.withExtVarsMixin

withExtVarsMixin(extVars)

"ExtVars is a list of Jsonnet External Variables"

Note: This function appends passed data to existing values

fn operation.sync.source.directory.jsonnet.withLibs

withLibs(libs)

"Additional library search dirs"

fn operation.sync.source.directory.jsonnet.withLibsMixin

withLibsMixin(libs)

"Additional library search dirs"

Note: This function appends passed data to existing values

fn operation.sync.source.directory.jsonnet.withTlas

withTlas(tlas)

"TLAS is a list of Jsonnet Top-level Arguments"

fn operation.sync.source.directory.jsonnet.withTlasMixin

withTlasMixin(tlas)

"TLAS is a list of Jsonnet Top-level Arguments"

Note: This function appends passed data to existing values

obj operation.sync.source.directory.jsonnet.extVars

"ExtVars is a list of Jsonnet External Variables"

fn operation.sync.source.directory.jsonnet.extVars.withCode

withCode(code)

fn operation.sync.source.directory.jsonnet.extVars.withName

withName(name)

fn operation.sync.source.directory.jsonnet.extVars.withValue

withValue(value)

obj operation.sync.source.directory.jsonnet.tlas

"TLAS is a list of Jsonnet Top-level Arguments"

fn operation.sync.source.directory.jsonnet.tlas.withCode

withCode(code)

fn operation.sync.source.directory.jsonnet.tlas.withName

withName(name)

fn operation.sync.source.directory.jsonnet.tlas.withValue

withValue(value)

obj operation.sync.source.helm

"Helm holds helm specific options"

fn operation.sync.source.helm.withFileParameters

withFileParameters(fileParameters)

"FileParameters are file parameters to the helm template"

fn operation.sync.source.helm.withFileParametersMixin

withFileParametersMixin(fileParameters)

"FileParameters are file parameters to the helm template"

Note: This function appends passed data to existing values

fn operation.sync.source.helm.withIgnoreMissingValueFiles

withIgnoreMissingValueFiles(ignoreMissingValueFiles)

"IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values"

fn operation.sync.source.helm.withParameters

withParameters(parameters)

"Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation"

fn operation.sync.source.helm.withParametersMixin

withParametersMixin(parameters)

"Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation"

Note: This function appends passed data to existing values

fn operation.sync.source.helm.withPassCredentials

withPassCredentials(passCredentials)

"PassCredentials pass credentials to all domains (Helm's --pass-credentials)"

fn operation.sync.source.helm.withReleaseName

withReleaseName(releaseName)

"ReleaseName is the Helm release name to use. If omitted it will use the application name"

fn operation.sync.source.helm.withSkipCrds

withSkipCrds(skipCrds)

"SkipCrds skips custom resource definition installation step (Helm's --skip-crds)"

fn operation.sync.source.helm.withValueFiles

withValueFiles(valueFiles)

"ValuesFiles is a list of Helm value files to use when generating a template"

fn operation.sync.source.helm.withValueFilesMixin

withValueFilesMixin(valueFiles)

"ValuesFiles is a list of Helm value files to use when generating a template"

Note: This function appends passed data to existing values

fn operation.sync.source.helm.withValues

withValues(values)

"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."

fn operation.sync.source.helm.withValuesObject

withValuesObject(valuesObject)

"ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values."

fn operation.sync.source.helm.withValuesObjectMixin

withValuesObjectMixin(valuesObject)

"ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values."

Note: This function appends passed data to existing values

fn operation.sync.source.helm.withVersion

withVersion(version)

"Version is the Helm version to use for templating (\"3\")"

obj operation.sync.source.helm.fileParameters

"FileParameters are file parameters to the helm template"

fn operation.sync.source.helm.fileParameters.withName

withName(name)

"Name is the name of the Helm parameter"

fn operation.sync.source.helm.fileParameters.withPath

withPath(path)

"Path is the path to the file containing the values for the Helm parameter"

obj operation.sync.source.helm.parameters

"Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation"

fn operation.sync.source.helm.parameters.withForceString

withForceString(forceString)

"ForceString determines whether to tell Helm to interpret booleans and numbers as strings"

fn operation.sync.source.helm.parameters.withName

withName(name)

"Name is the name of the Helm parameter"

fn operation.sync.source.helm.parameters.withValue

withValue(value)

"Value is the value for the Helm parameter"

obj operation.sync.source.kustomize

"Kustomize holds kustomize specific options"

fn operation.sync.source.kustomize.withCommonAnnotations

withCommonAnnotations(commonAnnotations)

"CommonAnnotations is a list of additional annotations to add to rendered manifests"

fn operation.sync.source.kustomize.withCommonAnnotationsEnvsubst

withCommonAnnotationsEnvsubst(commonAnnotationsEnvsubst)

"CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values"

fn operation.sync.source.kustomize.withCommonAnnotationsMixin

withCommonAnnotationsMixin(commonAnnotations)

"CommonAnnotations is a list of additional annotations to add to rendered manifests"

Note: This function appends passed data to existing values

fn operation.sync.source.kustomize.withCommonLabels

withCommonLabels(commonLabels)

"CommonLabels is a list of additional labels to add to rendered manifests"

fn operation.sync.source.kustomize.withCommonLabelsMixin

withCommonLabelsMixin(commonLabels)

"CommonLabels is a list of additional labels to add to rendered manifests"

Note: This function appends passed data to existing values

fn operation.sync.source.kustomize.withComponents

withComponents(components)

"Components specifies a list of kustomize components to add to the kustomization before building"

fn operation.sync.source.kustomize.withComponentsMixin

withComponentsMixin(components)

"Components specifies a list of kustomize components to add to the kustomization before building"

Note: This function appends passed data to existing values

fn operation.sync.source.kustomize.withForceCommonAnnotations

withForceCommonAnnotations(forceCommonAnnotations)

"ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps"

fn operation.sync.source.kustomize.withForceCommonLabels

withForceCommonLabels(forceCommonLabels)

"ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps"

fn operation.sync.source.kustomize.withImages

withImages(images)

"Images is a list of Kustomize image override specifications"

fn operation.sync.source.kustomize.withImagesMixin

withImagesMixin(images)

"Images is a list of Kustomize image override specifications"

Note: This function appends passed data to existing values

fn operation.sync.source.kustomize.withLabelWithoutSelector

withLabelWithoutSelector(labelWithoutSelector)

"LabelWithoutSelector specifies whether to apply common labels to resource selectors or not"

fn operation.sync.source.kustomize.withNamePrefix

withNamePrefix(namePrefix)

"NamePrefix is a prefix appended to resources for Kustomize apps"

fn operation.sync.source.kustomize.withNameSuffix

withNameSuffix(nameSuffix)

"NameSuffix is a suffix appended to resources for Kustomize apps"

fn operation.sync.source.kustomize.withNamespace

withNamespace(namespace)

"Namespace sets the namespace that Kustomize adds to all resources"

fn operation.sync.source.kustomize.withPatches

withPatches(patches)

"Patches is a list of Kustomize patches"

fn operation.sync.source.kustomize.withPatchesMixin

withPatchesMixin(patches)

"Patches is a list of Kustomize patches"

Note: This function appends passed data to existing values

fn operation.sync.source.kustomize.withReplicas

withReplicas(replicas)

"Replicas is a list of Kustomize Replicas override specifications"

fn operation.sync.source.kustomize.withReplicasMixin

withReplicasMixin(replicas)

"Replicas is a list of Kustomize Replicas override specifications"

Note: This function appends passed data to existing values

fn operation.sync.source.kustomize.withVersion

withVersion(version)

"Version controls which version of Kustomize to use for rendering manifests"

obj operation.sync.source.kustomize.patches

"Patches is a list of Kustomize patches"

fn operation.sync.source.kustomize.patches.withOptions

withOptions(options)

fn operation.sync.source.kustomize.patches.withOptionsMixin

withOptionsMixin(options)

Note: This function appends passed data to existing values

fn operation.sync.source.kustomize.patches.withPatch

withPatch(patch)

fn operation.sync.source.kustomize.patches.withPath

withPath(path)

obj operation.sync.source.kustomize.patches.target

fn operation.sync.source.kustomize.patches.target.withAnnotationSelector

withAnnotationSelector(annotationSelector)

fn operation.sync.source.kustomize.patches.target.withGroup

withGroup(group)

fn operation.sync.source.kustomize.patches.target.withKind

withKind(kind)

fn operation.sync.source.kustomize.patches.target.withLabelSelector

withLabelSelector(labelSelector)

fn operation.sync.source.kustomize.patches.target.withName

withName(name)

fn operation.sync.source.kustomize.patches.target.withNamespace

withNamespace(namespace)

fn operation.sync.source.kustomize.patches.target.withVersion

withVersion(version)

obj operation.sync.source.kustomize.replicas

"Replicas is a list of Kustomize Replicas override specifications"

fn operation.sync.source.kustomize.replicas.withCount

withCount(count)

"Number of replicas"

fn operation.sync.source.kustomize.replicas.withName

withName(name)

"Name of Deployment or StatefulSet"

obj operation.sync.source.plugin

"Plugin holds config management plugin specific options"

fn operation.sync.source.plugin.withEnv

withEnv(env)

"Env is a list of environment variable entries"

fn operation.sync.source.plugin.withEnvMixin

withEnvMixin(env)

"Env is a list of environment variable entries"

Note: This function appends passed data to existing values

fn operation.sync.source.plugin.withName

withName(name)

fn operation.sync.source.plugin.withParameters

withParameters(parameters)

fn operation.sync.source.plugin.withParametersMixin

withParametersMixin(parameters)

Note: This function appends passed data to existing values

obj operation.sync.source.plugin.env

"Env is a list of environment variable entries"

fn operation.sync.source.plugin.env.withName

withName(name)

"Name is the name of the variable, usually expressed in uppercase"

fn operation.sync.source.plugin.env.withValue

withValue(value)

"Value is the value of the variable"

obj operation.sync.source.plugin.parameters

fn operation.sync.source.plugin.parameters.withArray

withArray(array)

"Array is the value of an array type parameter."

fn operation.sync.source.plugin.parameters.withArrayMixin

withArrayMixin(array)

"Array is the value of an array type parameter."

Note: This function appends passed data to existing values

fn operation.sync.source.plugin.parameters.withMap

withMap(map)

"Map is the value of a map type parameter."

fn operation.sync.source.plugin.parameters.withMapMixin

withMapMixin(map)

"Map is the value of a map type parameter."

Note: This function appends passed data to existing values

fn operation.sync.source.plugin.parameters.withName

withName(name)

"Name is the name identifying a parameter."

fn operation.sync.source.plugin.parameters.withString

withString(string)

"String_ is the value of a string type parameter."

obj operation.sync.sources

"Sources overrides the source definition set in the application. This is typically set in a Rollback operation and is nil during a Sync operation"

fn operation.sync.sources.withChart

withChart(chart)

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

fn operation.sync.sources.withPath

withPath(path)

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

fn operation.sync.sources.withRef

withRef(ref)

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

fn operation.sync.sources.withRepoURL

withRepoURL(repoURL)

"RepoURL is the URL to the repository (Git or Helm) that contains the application manifests"

fn operation.sync.sources.withTargetRevision

withTargetRevision(targetRevision)

"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."

obj operation.sync.sources.directory

"Directory holds path/directory specific options"

fn operation.sync.sources.directory.withExclude

withExclude(exclude)

"Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation"

fn operation.sync.sources.directory.withInclude

withInclude(include)

"Include contains a glob pattern to match paths against that should be explicitly included during manifest generation"

fn operation.sync.sources.directory.withRecurse

withRecurse(recurse)

"Recurse specifies whether to scan a directory recursively for manifests"

obj operation.sync.sources.directory.jsonnet

"Jsonnet holds options specific to Jsonnet"

fn operation.sync.sources.directory.jsonnet.withExtVars

withExtVars(extVars)

"ExtVars is a list of Jsonnet External Variables"

fn operation.sync.sources.directory.jsonnet.withExtVarsMixin

withExtVarsMixin(extVars)

"ExtVars is a list of Jsonnet External Variables"

Note: This function appends passed data to existing values

fn operation.sync.sources.directory.jsonnet.withLibs

withLibs(libs)

"Additional library search dirs"

fn operation.sync.sources.directory.jsonnet.withLibsMixin

withLibsMixin(libs)

"Additional library search dirs"

Note: This function appends passed data to existing values

fn operation.sync.sources.directory.jsonnet.withTlas

withTlas(tlas)

"TLAS is a list of Jsonnet Top-level Arguments"

fn operation.sync.sources.directory.jsonnet.withTlasMixin

withTlasMixin(tlas)

"TLAS is a list of Jsonnet Top-level Arguments"

Note: This function appends passed data to existing values

obj operation.sync.sources.directory.jsonnet.extVars

"ExtVars is a list of Jsonnet External Variables"

fn operation.sync.sources.directory.jsonnet.extVars.withCode

withCode(code)

fn operation.sync.sources.directory.jsonnet.extVars.withName

withName(name)

fn operation.sync.sources.directory.jsonnet.extVars.withValue

withValue(value)

obj operation.sync.sources.directory.jsonnet.tlas

"TLAS is a list of Jsonnet Top-level Arguments"

fn operation.sync.sources.directory.jsonnet.tlas.withCode

withCode(code)

fn operation.sync.sources.directory.jsonnet.tlas.withName

withName(name)

fn operation.sync.sources.directory.jsonnet.tlas.withValue

withValue(value)

obj operation.sync.sources.helm

"Helm holds helm specific options"

fn operation.sync.sources.helm.withFileParameters

withFileParameters(fileParameters)

"FileParameters are file parameters to the helm template"

fn operation.sync.sources.helm.withFileParametersMixin

withFileParametersMixin(fileParameters)

"FileParameters are file parameters to the helm template"

Note: This function appends passed data to existing values

fn operation.sync.sources.helm.withIgnoreMissingValueFiles

withIgnoreMissingValueFiles(ignoreMissingValueFiles)

"IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values"

fn operation.sync.sources.helm.withParameters

withParameters(parameters)

"Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation"

fn operation.sync.sources.helm.withParametersMixin

withParametersMixin(parameters)

"Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation"

Note: This function appends passed data to existing values

fn operation.sync.sources.helm.withPassCredentials

withPassCredentials(passCredentials)

"PassCredentials pass credentials to all domains (Helm's --pass-credentials)"

fn operation.sync.sources.helm.withReleaseName

withReleaseName(releaseName)

"ReleaseName is the Helm release name to use. If omitted it will use the application name"

fn operation.sync.sources.helm.withSkipCrds

withSkipCrds(skipCrds)

"SkipCrds skips custom resource definition installation step (Helm's --skip-crds)"

fn operation.sync.sources.helm.withValueFiles

withValueFiles(valueFiles)

"ValuesFiles is a list of Helm value files to use when generating a template"

fn operation.sync.sources.helm.withValueFilesMixin

withValueFilesMixin(valueFiles)

"ValuesFiles is a list of Helm value files to use when generating a template"

Note: This function appends passed data to existing values

fn operation.sync.sources.helm.withValues

withValues(values)

"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."

fn operation.sync.sources.helm.withValuesObject

withValuesObject(valuesObject)

"ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values."

fn operation.sync.sources.helm.withValuesObjectMixin

withValuesObjectMixin(valuesObject)

"ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values."

Note: This function appends passed data to existing values

fn operation.sync.sources.helm.withVersion

withVersion(version)

"Version is the Helm version to use for templating (\"3\")"

obj operation.sync.sources.helm.fileParameters

"FileParameters are file parameters to the helm template"

fn operation.sync.sources.helm.fileParameters.withName

withName(name)

"Name is the name of the Helm parameter"

fn operation.sync.sources.helm.fileParameters.withPath

withPath(path)

"Path is the path to the file containing the values for the Helm parameter"

obj operation.sync.sources.helm.parameters

"Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation"

fn operation.sync.sources.helm.parameters.withForceString

withForceString(forceString)

"ForceString determines whether to tell Helm to interpret booleans and numbers as strings"

fn operation.sync.sources.helm.parameters.withName

withName(name)

"Name is the name of the Helm parameter"

fn operation.sync.sources.helm.parameters.withValue

withValue(value)

"Value is the value for the Helm parameter"

obj operation.sync.sources.kustomize

"Kustomize holds kustomize specific options"

fn operation.sync.sources.kustomize.withCommonAnnotations

withCommonAnnotations(commonAnnotations)

"CommonAnnotations is a list of additional annotations to add to rendered manifests"

fn operation.sync.sources.kustomize.withCommonAnnotationsEnvsubst

withCommonAnnotationsEnvsubst(commonAnnotationsEnvsubst)

"CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values"

fn operation.sync.sources.kustomize.withCommonAnnotationsMixin

withCommonAnnotationsMixin(commonAnnotations)

"CommonAnnotations is a list of additional annotations to add to rendered manifests"

Note: This function appends passed data to existing values

fn operation.sync.sources.kustomize.withCommonLabels

withCommonLabels(commonLabels)

"CommonLabels is a list of additional labels to add to rendered manifests"

fn operation.sync.sources.kustomize.withCommonLabelsMixin

withCommonLabelsMixin(commonLabels)

"CommonLabels is a list of additional labels to add to rendered manifests"

Note: This function appends passed data to existing values

fn operation.sync.sources.kustomize.withComponents

withComponents(components)

"Components specifies a list of kustomize components to add to the kustomization before building"

fn operation.sync.sources.kustomize.withComponentsMixin

withComponentsMixin(components)

"Components specifies a list of kustomize components to add to the kustomization before building"

Note: This function appends passed data to existing values

fn operation.sync.sources.kustomize.withForceCommonAnnotations

withForceCommonAnnotations(forceCommonAnnotations)

"ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps"

fn operation.sync.sources.kustomize.withForceCommonLabels

withForceCommonLabels(forceCommonLabels)

"ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps"

fn operation.sync.sources.kustomize.withImages

withImages(images)

"Images is a list of Kustomize image override specifications"

fn operation.sync.sources.kustomize.withImagesMixin

withImagesMixin(images)

"Images is a list of Kustomize image override specifications"

Note: This function appends passed data to existing values

fn operation.sync.sources.kustomize.withLabelWithoutSelector

withLabelWithoutSelector(labelWithoutSelector)

"LabelWithoutSelector specifies whether to apply common labels to resource selectors or not"

fn operation.sync.sources.kustomize.withNamePrefix

withNamePrefix(namePrefix)

"NamePrefix is a prefix appended to resources for Kustomize apps"

fn operation.sync.sources.kustomize.withNameSuffix

withNameSuffix(nameSuffix)

"NameSuffix is a suffix appended to resources for Kustomize apps"

fn operation.sync.sources.kustomize.withNamespace

withNamespace(namespace)

"Namespace sets the namespace that Kustomize adds to all resources"

fn operation.sync.sources.kustomize.withPatches

withPatches(patches)

"Patches is a list of Kustomize patches"

fn operation.sync.sources.kustomize.withPatchesMixin

withPatchesMixin(patches)

"Patches is a list of Kustomize patches"

Note: This function appends passed data to existing values

fn operation.sync.sources.kustomize.withReplicas

withReplicas(replicas)

"Replicas is a list of Kustomize Replicas override specifications"

fn operation.sync.sources.kustomize.withReplicasMixin

withReplicasMixin(replicas)

"Replicas is a list of Kustomize Replicas override specifications"

Note: This function appends passed data to existing values

fn operation.sync.sources.kustomize.withVersion

withVersion(version)

"Version controls which version of Kustomize to use for rendering manifests"

obj operation.sync.sources.kustomize.patches

"Patches is a list of Kustomize patches"

fn operation.sync.sources.kustomize.patches.withOptions

withOptions(options)

fn operation.sync.sources.kustomize.patches.withOptionsMixin

withOptionsMixin(options)

Note: This function appends passed data to existing values

fn operation.sync.sources.kustomize.patches.withPatch

withPatch(patch)

fn operation.sync.sources.kustomize.patches.withPath

withPath(path)

obj operation.sync.sources.kustomize.patches.target

fn operation.sync.sources.kustomize.patches.target.withAnnotationSelector

withAnnotationSelector(annotationSelector)

fn operation.sync.sources.kustomize.patches.target.withGroup

withGroup(group)

fn operation.sync.sources.kustomize.patches.target.withKind

withKind(kind)

fn operation.sync.sources.kustomize.patches.target.withLabelSelector

withLabelSelector(labelSelector)

fn operation.sync.sources.kustomize.patches.target.withName

withName(name)

fn operation.sync.sources.kustomize.patches.target.withNamespace

withNamespace(namespace)

fn operation.sync.sources.kustomize.patches.target.withVersion

withVersion(version)

obj operation.sync.sources.kustomize.replicas

"Replicas is a list of Kustomize Replicas override specifications"

fn operation.sync.sources.kustomize.replicas.withCount

withCount(count)

"Number of replicas"

fn operation.sync.sources.kustomize.replicas.withName

withName(name)

"Name of Deployment or StatefulSet"

obj operation.sync.sources.plugin

"Plugin holds config management plugin specific options"

fn operation.sync.sources.plugin.withEnv

withEnv(env)

"Env is a list of environment variable entries"

fn operation.sync.sources.plugin.withEnvMixin

withEnvMixin(env)

"Env is a list of environment variable entries"

Note: This function appends passed data to existing values

fn operation.sync.sources.plugin.withName

withName(name)

fn operation.sync.sources.plugin.withParameters

withParameters(parameters)

fn operation.sync.sources.plugin.withParametersMixin

withParametersMixin(parameters)

Note: This function appends passed data to existing values

obj operation.sync.sources.plugin.env

"Env is a list of environment variable entries"

fn operation.sync.sources.plugin.env.withName

withName(name)

"Name is the name of the variable, usually expressed in uppercase"

fn operation.sync.sources.plugin.env.withValue

withValue(value)

"Value is the value of the variable"

obj operation.sync.sources.plugin.parameters

fn operation.sync.sources.plugin.parameters.withArray

withArray(array)

"Array is the value of an array type parameter."

fn operation.sync.sources.plugin.parameters.withArrayMixin

withArrayMixin(array)

"Array is the value of an array type parameter."

Note: This function appends passed data to existing values

fn operation.sync.sources.plugin.parameters.withMap

withMap(map)

"Map is the value of a map type parameter."

fn operation.sync.sources.plugin.parameters.withMapMixin

withMapMixin(map)

"Map is the value of a map type parameter."

Note: This function appends passed data to existing values

fn operation.sync.sources.plugin.parameters.withName

withName(name)

"Name is the name identifying a parameter."

fn operation.sync.sources.plugin.parameters.withString

withString(string)

"String_ is the value of a string type parameter."

obj operation.sync.syncStrategy

"SyncStrategy describes how to perform the sync"

obj operation.sync.syncStrategy.apply

"Apply will perform a kubectl apply to perform the sync."

fn operation.sync.syncStrategy.apply.withForce

withForce(force)

"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."

obj operation.sync.syncStrategy.hook

"Hook will submit any referenced resources to perform the sync. This is the default strategy"

fn operation.sync.syncStrategy.hook.withForce

withForce(force)

"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."

obj spec

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

fn spec.withIgnoreDifferences

withIgnoreDifferences(ignoreDifferences)

"IgnoreDifferences is a list of resources and their fields which should be ignored during comparison"

fn spec.withIgnoreDifferencesMixin

withIgnoreDifferencesMixin(ignoreDifferences)

"IgnoreDifferences is a list of resources and their fields which should be ignored during comparison"

Note: This function appends passed data to existing values

fn spec.withInfo

withInfo(info)

"Info contains a list of information (URLs, email addresses, and plain text) that relates to the application"

fn spec.withInfoMixin

withInfoMixin(info)

"Info contains a list of information (URLs, email addresses, and plain text) that relates to the application"

Note: This function appends passed data to existing values

fn spec.withProject

withProject(project)

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

fn spec.withRevisionHistoryLimit

withRevisionHistoryLimit(revisionHistoryLimit)

"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."

fn spec.withSources

withSources(sources)

"Sources is a reference to the location of the application's manifests or chart"

fn spec.withSourcesMixin

withSourcesMixin(sources)

"Sources is a reference to the location of the application's manifests or chart"

Note: This function appends passed data to existing values

obj spec.destination

"Destination is a reference to the target Kubernetes server and namespace"

fn spec.destination.withName

withName(name)

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

fn spec.destination.withNamespace

withNamespace(namespace)

"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"

fn spec.destination.withServer

withServer(server)

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

obj spec.ignoreDifferences

"IgnoreDifferences is a list of resources and their fields which should be ignored during comparison"

fn spec.ignoreDifferences.withGroup

withGroup(group)

fn spec.ignoreDifferences.withJqPathExpressions

withJqPathExpressions(jqPathExpressions)

fn spec.ignoreDifferences.withJqPathExpressionsMixin

withJqPathExpressionsMixin(jqPathExpressions)

Note: This function appends passed data to existing values

fn spec.ignoreDifferences.withJsonPointers

withJsonPointers(jsonPointers)

fn spec.ignoreDifferences.withJsonPointersMixin

withJsonPointersMixin(jsonPointers)

Note: This function appends passed data to existing values

fn spec.ignoreDifferences.withKind

withKind(kind)

fn spec.ignoreDifferences.withManagedFieldsManagers

withManagedFieldsManagers(managedFieldsManagers)

"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"

fn spec.ignoreDifferences.withManagedFieldsManagersMixin

withManagedFieldsManagersMixin(managedFieldsManagers)

"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"

Note: This function appends passed data to existing values

fn spec.ignoreDifferences.withName

withName(name)

fn spec.ignoreDifferences.withNamespace

withNamespace(namespace)

obj spec.info

"Info contains a list of information (URLs, email addresses, and plain text) that relates to the application"

fn spec.info.withName

withName(name)

fn spec.info.withValue

withValue(value)

obj spec.source

"Source is a reference to the location of the application's manifests or chart"

fn spec.source.withChart

withChart(chart)

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

fn spec.source.withPath

withPath(path)

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

fn spec.source.withRef

withRef(ref)

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

fn spec.source.withRepoURL

withRepoURL(repoURL)

"RepoURL is the URL to the repository (Git or Helm) that contains the application manifests"

fn spec.source.withTargetRevision

withTargetRevision(targetRevision)

"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."

obj spec.source.directory

"Directory holds path/directory specific options"

fn spec.source.directory.withExclude

withExclude(exclude)

"Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation"

fn spec.source.directory.withInclude

withInclude(include)

"Include contains a glob pattern to match paths against that should be explicitly included during manifest generation"

fn spec.source.directory.withRecurse

withRecurse(recurse)

"Recurse specifies whether to scan a directory recursively for manifests"

obj spec.source.directory.jsonnet

"Jsonnet holds options specific to Jsonnet"

fn spec.source.directory.jsonnet.withExtVars

withExtVars(extVars)

"ExtVars is a list of Jsonnet External Variables"

fn spec.source.directory.jsonnet.withExtVarsMixin

withExtVarsMixin(extVars)

"ExtVars is a list of Jsonnet External Variables"

Note: This function appends passed data to existing values

fn spec.source.directory.jsonnet.withLibs

withLibs(libs)

"Additional library search dirs"

fn spec.source.directory.jsonnet.withLibsMixin

withLibsMixin(libs)

"Additional library search dirs"

Note: This function appends passed data to existing values

fn spec.source.directory.jsonnet.withTlas

withTlas(tlas)

"TLAS is a list of Jsonnet Top-level Arguments"

fn spec.source.directory.jsonnet.withTlasMixin

withTlasMixin(tlas)

"TLAS is a list of Jsonnet Top-level Arguments"

Note: This function appends passed data to existing values

obj spec.source.directory.jsonnet.extVars

"ExtVars is a list of Jsonnet External Variables"

fn spec.source.directory.jsonnet.extVars.withCode

withCode(code)

fn spec.source.directory.jsonnet.extVars.withName

withName(name)

fn spec.source.directory.jsonnet.extVars.withValue

withValue(value)

obj spec.source.directory.jsonnet.tlas

"TLAS is a list of Jsonnet Top-level Arguments"

fn spec.source.directory.jsonnet.tlas.withCode

withCode(code)

fn spec.source.directory.jsonnet.tlas.withName

withName(name)

fn spec.source.directory.jsonnet.tlas.withValue

withValue(value)

obj spec.source.helm

"Helm holds helm specific options"

fn spec.source.helm.withFileParameters

withFileParameters(fileParameters)

"FileParameters are file parameters to the helm template"

fn spec.source.helm.withFileParametersMixin

withFileParametersMixin(fileParameters)

"FileParameters are file parameters to the helm template"

Note: This function appends passed data to existing values

fn spec.source.helm.withIgnoreMissingValueFiles

withIgnoreMissingValueFiles(ignoreMissingValueFiles)

"IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values"

fn spec.source.helm.withParameters

withParameters(parameters)

"Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation"

fn spec.source.helm.withParametersMixin

withParametersMixin(parameters)

"Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation"

Note: This function appends passed data to existing values

fn spec.source.helm.withPassCredentials

withPassCredentials(passCredentials)

"PassCredentials pass credentials to all domains (Helm's --pass-credentials)"

fn spec.source.helm.withReleaseName

withReleaseName(releaseName)

"ReleaseName is the Helm release name to use. If omitted it will use the application name"

fn spec.source.helm.withSkipCrds

withSkipCrds(skipCrds)

"SkipCrds skips custom resource definition installation step (Helm's --skip-crds)"

fn spec.source.helm.withValueFiles

withValueFiles(valueFiles)

"ValuesFiles is a list of Helm value files to use when generating a template"

fn spec.source.helm.withValueFilesMixin

withValueFilesMixin(valueFiles)

"ValuesFiles is a list of Helm value files to use when generating a template"

Note: This function appends passed data to existing values

fn spec.source.helm.withValues

withValues(values)

"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."

fn spec.source.helm.withValuesObject

withValuesObject(valuesObject)

"ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values."

fn spec.source.helm.withValuesObjectMixin

withValuesObjectMixin(valuesObject)

"ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values."

Note: This function appends passed data to existing values

fn spec.source.helm.withVersion

withVersion(version)

"Version is the Helm version to use for templating (\"3\")"

obj spec.source.helm.fileParameters

"FileParameters are file parameters to the helm template"

fn spec.source.helm.fileParameters.withName

withName(name)

"Name is the name of the Helm parameter"

fn spec.source.helm.fileParameters.withPath

withPath(path)

"Path is the path to the file containing the values for the Helm parameter"

obj spec.source.helm.parameters

"Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation"

fn spec.source.helm.parameters.withForceString

withForceString(forceString)

"ForceString determines whether to tell Helm to interpret booleans and numbers as strings"

fn spec.source.helm.parameters.withName

withName(name)

"Name is the name of the Helm parameter"

fn spec.source.helm.parameters.withValue

withValue(value)

"Value is the value for the Helm parameter"

obj spec.source.kustomize

"Kustomize holds kustomize specific options"

fn spec.source.kustomize.withCommonAnnotations

withCommonAnnotations(commonAnnotations)

"CommonAnnotations is a list of additional annotations to add to rendered manifests"

fn spec.source.kustomize.withCommonAnnotationsEnvsubst

withCommonAnnotationsEnvsubst(commonAnnotationsEnvsubst)

"CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values"

fn spec.source.kustomize.withCommonAnnotationsMixin

withCommonAnnotationsMixin(commonAnnotations)

"CommonAnnotations is a list of additional annotations to add to rendered manifests"

Note: This function appends passed data to existing values

fn spec.source.kustomize.withCommonLabels

withCommonLabels(commonLabels)

"CommonLabels is a list of additional labels to add to rendered manifests"

fn spec.source.kustomize.withCommonLabelsMixin

withCommonLabelsMixin(commonLabels)

"CommonLabels is a list of additional labels to add to rendered manifests"

Note: This function appends passed data to existing values

fn spec.source.kustomize.withComponents

withComponents(components)

"Components specifies a list of kustomize components to add to the kustomization before building"

fn spec.source.kustomize.withComponentsMixin

withComponentsMixin(components)

"Components specifies a list of kustomize components to add to the kustomization before building"

Note: This function appends passed data to existing values

fn spec.source.kustomize.withForceCommonAnnotations

withForceCommonAnnotations(forceCommonAnnotations)

"ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps"

fn spec.source.kustomize.withForceCommonLabels

withForceCommonLabels(forceCommonLabels)

"ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps"

fn spec.source.kustomize.withImages

withImages(images)

"Images is a list of Kustomize image override specifications"

fn spec.source.kustomize.withImagesMixin

withImagesMixin(images)

"Images is a list of Kustomize image override specifications"

Note: This function appends passed data to existing values

fn spec.source.kustomize.withLabelWithoutSelector

withLabelWithoutSelector(labelWithoutSelector)

"LabelWithoutSelector specifies whether to apply common labels to resource selectors or not"

fn spec.source.kustomize.withNamePrefix

withNamePrefix(namePrefix)

"NamePrefix is a prefix appended to resources for Kustomize apps"

fn spec.source.kustomize.withNameSuffix

withNameSuffix(nameSuffix)

"NameSuffix is a suffix appended to resources for Kustomize apps"

fn spec.source.kustomize.withNamespace

withNamespace(namespace)

"Namespace sets the namespace that Kustomize adds to all resources"

fn spec.source.kustomize.withPatches

withPatches(patches)

"Patches is a list of Kustomize patches"

fn spec.source.kustomize.withPatchesMixin

withPatchesMixin(patches)

"Patches is a list of Kustomize patches"

Note: This function appends passed data to existing values

fn spec.source.kustomize.withReplicas

withReplicas(replicas)

"Replicas is a list of Kustomize Replicas override specifications"

fn spec.source.kustomize.withReplicasMixin

withReplicasMixin(replicas)

"Replicas is a list of Kustomize Replicas override specifications"

Note: This function appends passed data to existing values

fn spec.source.kustomize.withVersion

withVersion(version)

"Version controls which version of Kustomize to use for rendering manifests"

obj spec.source.kustomize.patches

"Patches is a list of Kustomize patches"

fn spec.source.kustomize.patches.withOptions

withOptions(options)

fn spec.source.kustomize.patches.withOptionsMixin

withOptionsMixin(options)

Note: This function appends passed data to existing values

fn spec.source.kustomize.patches.withPatch

withPatch(patch)

fn spec.source.kustomize.patches.withPath

withPath(path)

obj spec.source.kustomize.patches.target

fn spec.source.kustomize.patches.target.withAnnotationSelector

withAnnotationSelector(annotationSelector)

fn spec.source.kustomize.patches.target.withGroup

withGroup(group)

fn spec.source.kustomize.patches.target.withKind

withKind(kind)

fn spec.source.kustomize.patches.target.withLabelSelector

withLabelSelector(labelSelector)

fn spec.source.kustomize.patches.target.withName

withName(name)

fn spec.source.kustomize.patches.target.withNamespace

withNamespace(namespace)

fn spec.source.kustomize.patches.target.withVersion

withVersion(version)

obj spec.source.kustomize.replicas

"Replicas is a list of Kustomize Replicas override specifications"

fn spec.source.kustomize.replicas.withCount

withCount(count)

"Number of replicas"

fn spec.source.kustomize.replicas.withName

withName(name)

"Name of Deployment or StatefulSet"

obj spec.source.plugin

"Plugin holds config management plugin specific options"

fn spec.source.plugin.withEnv

withEnv(env)

"Env is a list of environment variable entries"

fn spec.source.plugin.withEnvMixin

withEnvMixin(env)

"Env is a list of environment variable entries"

Note: This function appends passed data to existing values

fn spec.source.plugin.withName

withName(name)

fn spec.source.plugin.withParameters

withParameters(parameters)

fn spec.source.plugin.withParametersMixin

withParametersMixin(parameters)

Note: This function appends passed data to existing values

obj spec.source.plugin.env

"Env is a list of environment variable entries"

fn spec.source.plugin.env.withName

withName(name)

"Name is the name of the variable, usually expressed in uppercase"

fn spec.source.plugin.env.withValue

withValue(value)

"Value is the value of the variable"

obj spec.source.plugin.parameters

fn spec.source.plugin.parameters.withArray

withArray(array)

"Array is the value of an array type parameter."

fn spec.source.plugin.parameters.withArrayMixin

withArrayMixin(array)

"Array is the value of an array type parameter."

Note: This function appends passed data to existing values

fn spec.source.plugin.parameters.withMap

withMap(map)

"Map is the value of a map type parameter."

fn spec.source.plugin.parameters.withMapMixin

withMapMixin(map)

"Map is the value of a map type parameter."

Note: This function appends passed data to existing values

fn spec.source.plugin.parameters.withName

withName(name)

"Name is the name identifying a parameter."

fn spec.source.plugin.parameters.withString

withString(string)

"String_ is the value of a string type parameter."

obj spec.sources

"Sources is a reference to the location of the application's manifests or chart"

fn spec.sources.withChart

withChart(chart)

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

fn spec.sources.withPath

withPath(path)

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

fn spec.sources.withRef

withRef(ref)

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

fn spec.sources.withRepoURL

withRepoURL(repoURL)

"RepoURL is the URL to the repository (Git or Helm) that contains the application manifests"

fn spec.sources.withTargetRevision

withTargetRevision(targetRevision)

"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."

obj spec.sources.directory

"Directory holds path/directory specific options"

fn spec.sources.directory.withExclude

withExclude(exclude)

"Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during manifest generation"

fn spec.sources.directory.withInclude

withInclude(include)

"Include contains a glob pattern to match paths against that should be explicitly included during manifest generation"

fn spec.sources.directory.withRecurse

withRecurse(recurse)

"Recurse specifies whether to scan a directory recursively for manifests"

obj spec.sources.directory.jsonnet

"Jsonnet holds options specific to Jsonnet"

fn spec.sources.directory.jsonnet.withExtVars

withExtVars(extVars)

"ExtVars is a list of Jsonnet External Variables"

fn spec.sources.directory.jsonnet.withExtVarsMixin

withExtVarsMixin(extVars)

"ExtVars is a list of Jsonnet External Variables"

Note: This function appends passed data to existing values

fn spec.sources.directory.jsonnet.withLibs

withLibs(libs)

"Additional library search dirs"

fn spec.sources.directory.jsonnet.withLibsMixin

withLibsMixin(libs)

"Additional library search dirs"

Note: This function appends passed data to existing values

fn spec.sources.directory.jsonnet.withTlas

withTlas(tlas)

"TLAS is a list of Jsonnet Top-level Arguments"

fn spec.sources.directory.jsonnet.withTlasMixin

withTlasMixin(tlas)

"TLAS is a list of Jsonnet Top-level Arguments"

Note: This function appends passed data to existing values

obj spec.sources.directory.jsonnet.extVars

"ExtVars is a list of Jsonnet External Variables"

fn spec.sources.directory.jsonnet.extVars.withCode

withCode(code)

fn spec.sources.directory.jsonnet.extVars.withName

withName(name)

fn spec.sources.directory.jsonnet.extVars.withValue

withValue(value)

obj spec.sources.directory.jsonnet.tlas

"TLAS is a list of Jsonnet Top-level Arguments"

fn spec.sources.directory.jsonnet.tlas.withCode

withCode(code)

fn spec.sources.directory.jsonnet.tlas.withName

withName(name)

fn spec.sources.directory.jsonnet.tlas.withValue

withValue(value)

obj spec.sources.helm

"Helm holds helm specific options"

fn spec.sources.helm.withFileParameters

withFileParameters(fileParameters)

"FileParameters are file parameters to the helm template"

fn spec.sources.helm.withFileParametersMixin

withFileParametersMixin(fileParameters)

"FileParameters are file parameters to the helm template"

Note: This function appends passed data to existing values

fn spec.sources.helm.withIgnoreMissingValueFiles

withIgnoreMissingValueFiles(ignoreMissingValueFiles)

"IgnoreMissingValueFiles prevents helm template from failing when valueFiles do not exist locally by not appending them to helm template --values"

fn spec.sources.helm.withParameters

withParameters(parameters)

"Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation"

fn spec.sources.helm.withParametersMixin

withParametersMixin(parameters)

"Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation"

Note: This function appends passed data to existing values

fn spec.sources.helm.withPassCredentials

withPassCredentials(passCredentials)

"PassCredentials pass credentials to all domains (Helm's --pass-credentials)"

fn spec.sources.helm.withReleaseName

withReleaseName(releaseName)

"ReleaseName is the Helm release name to use. If omitted it will use the application name"

fn spec.sources.helm.withSkipCrds

withSkipCrds(skipCrds)

"SkipCrds skips custom resource definition installation step (Helm's --skip-crds)"

fn spec.sources.helm.withValueFiles

withValueFiles(valueFiles)

"ValuesFiles is a list of Helm value files to use when generating a template"

fn spec.sources.helm.withValueFilesMixin

withValueFilesMixin(valueFiles)

"ValuesFiles is a list of Helm value files to use when generating a template"

Note: This function appends passed data to existing values

fn spec.sources.helm.withValues

withValues(values)

"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."

fn spec.sources.helm.withValuesObject

withValuesObject(valuesObject)

"ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values."

fn spec.sources.helm.withValuesObjectMixin

withValuesObjectMixin(valuesObject)

"ValuesObject specifies Helm values to be passed to helm template, defined as a map. This takes precedence over Values."

Note: This function appends passed data to existing values

fn spec.sources.helm.withVersion

withVersion(version)

"Version is the Helm version to use for templating (\"3\")"

obj spec.sources.helm.fileParameters

"FileParameters are file parameters to the helm template"

fn spec.sources.helm.fileParameters.withName

withName(name)

"Name is the name of the Helm parameter"

fn spec.sources.helm.fileParameters.withPath

withPath(path)

"Path is the path to the file containing the values for the Helm parameter"

obj spec.sources.helm.parameters

"Parameters is a list of Helm parameters which are passed to the helm template command upon manifest generation"

fn spec.sources.helm.parameters.withForceString

withForceString(forceString)

"ForceString determines whether to tell Helm to interpret booleans and numbers as strings"

fn spec.sources.helm.parameters.withName

withName(name)

"Name is the name of the Helm parameter"

fn spec.sources.helm.parameters.withValue

withValue(value)

"Value is the value for the Helm parameter"

obj spec.sources.kustomize

"Kustomize holds kustomize specific options"

fn spec.sources.kustomize.withCommonAnnotations

withCommonAnnotations(commonAnnotations)

"CommonAnnotations is a list of additional annotations to add to rendered manifests"

fn spec.sources.kustomize.withCommonAnnotationsEnvsubst

withCommonAnnotationsEnvsubst(commonAnnotationsEnvsubst)

"CommonAnnotationsEnvsubst specifies whether to apply env variables substitution for annotation values"

fn spec.sources.kustomize.withCommonAnnotationsMixin

withCommonAnnotationsMixin(commonAnnotations)

"CommonAnnotations is a list of additional annotations to add to rendered manifests"

Note: This function appends passed data to existing values

fn spec.sources.kustomize.withCommonLabels

withCommonLabels(commonLabels)

"CommonLabels is a list of additional labels to add to rendered manifests"

fn spec.sources.kustomize.withCommonLabelsMixin

withCommonLabelsMixin(commonLabels)

"CommonLabels is a list of additional labels to add to rendered manifests"

Note: This function appends passed data to existing values

fn spec.sources.kustomize.withComponents

withComponents(components)

"Components specifies a list of kustomize components to add to the kustomization before building"

fn spec.sources.kustomize.withComponentsMixin

withComponentsMixin(components)

"Components specifies a list of kustomize components to add to the kustomization before building"

Note: This function appends passed data to existing values

fn spec.sources.kustomize.withForceCommonAnnotations

withForceCommonAnnotations(forceCommonAnnotations)

"ForceCommonAnnotations specifies whether to force applying common annotations to resources for Kustomize apps"

fn spec.sources.kustomize.withForceCommonLabels

withForceCommonLabels(forceCommonLabels)

"ForceCommonLabels specifies whether to force applying common labels to resources for Kustomize apps"

fn spec.sources.kustomize.withImages

withImages(images)

"Images is a list of Kustomize image override specifications"

fn spec.sources.kustomize.withImagesMixin

withImagesMixin(images)

"Images is a list of Kustomize image override specifications"

Note: This function appends passed data to existing values

fn spec.sources.kustomize.withLabelWithoutSelector

withLabelWithoutSelector(labelWithoutSelector)

"LabelWithoutSelector specifies whether to apply common labels to resource selectors or not"

fn spec.sources.kustomize.withNamePrefix

withNamePrefix(namePrefix)

"NamePrefix is a prefix appended to resources for Kustomize apps"

fn spec.sources.kustomize.withNameSuffix

withNameSuffix(nameSuffix)

"NameSuffix is a suffix appended to resources for Kustomize apps"

fn spec.sources.kustomize.withNamespace

withNamespace(namespace)

"Namespace sets the namespace that Kustomize adds to all resources"

fn spec.sources.kustomize.withPatches

withPatches(patches)

"Patches is a list of Kustomize patches"

fn spec.sources.kustomize.withPatchesMixin

withPatchesMixin(patches)

"Patches is a list of Kustomize patches"

Note: This function appends passed data to existing values

fn spec.sources.kustomize.withReplicas

withReplicas(replicas)

"Replicas is a list of Kustomize Replicas override specifications"

fn spec.sources.kustomize.withReplicasMixin

withReplicasMixin(replicas)

"Replicas is a list of Kustomize Replicas override specifications"

Note: This function appends passed data to existing values

fn spec.sources.kustomize.withVersion

withVersion(version)

"Version controls which version of Kustomize to use for rendering manifests"

obj spec.sources.kustomize.patches

"Patches is a list of Kustomize patches"

fn spec.sources.kustomize.patches.withOptions

withOptions(options)

fn spec.sources.kustomize.patches.withOptionsMixin

withOptionsMixin(options)

Note: This function appends passed data to existing values

fn spec.sources.kustomize.patches.withPatch

withPatch(patch)

fn spec.sources.kustomize.patches.withPath

withPath(path)

obj spec.sources.kustomize.patches.target

fn spec.sources.kustomize.patches.target.withAnnotationSelector

withAnnotationSelector(annotationSelector)

fn spec.sources.kustomize.patches.target.withGroup

withGroup(group)

fn spec.sources.kustomize.patches.target.withKind

withKind(kind)

fn spec.sources.kustomize.patches.target.withLabelSelector

withLabelSelector(labelSelector)

fn spec.sources.kustomize.patches.target.withName

withName(name)

fn spec.sources.kustomize.patches.target.withNamespace

withNamespace(namespace)

fn spec.sources.kustomize.patches.target.withVersion

withVersion(version)

obj spec.sources.kustomize.replicas

"Replicas is a list of Kustomize Replicas override specifications"

fn spec.sources.kustomize.replicas.withCount

withCount(count)

"Number of replicas"

fn spec.sources.kustomize.replicas.withName

withName(name)

"Name of Deployment or StatefulSet"

obj spec.sources.plugin

"Plugin holds config management plugin specific options"

fn spec.sources.plugin.withEnv

withEnv(env)

"Env is a list of environment variable entries"

fn spec.sources.plugin.withEnvMixin

withEnvMixin(env)

"Env is a list of environment variable entries"

Note: This function appends passed data to existing values

fn spec.sources.plugin.withName

withName(name)

fn spec.sources.plugin.withParameters

withParameters(parameters)

fn spec.sources.plugin.withParametersMixin

withParametersMixin(parameters)

Note: This function appends passed data to existing values

obj spec.sources.plugin.env

"Env is a list of environment variable entries"

fn spec.sources.plugin.env.withName

withName(name)

"Name is the name of the variable, usually expressed in uppercase"

fn spec.sources.plugin.env.withValue

withValue(value)

"Value is the value of the variable"

obj spec.sources.plugin.parameters

fn spec.sources.plugin.parameters.withArray

withArray(array)

"Array is the value of an array type parameter."

fn spec.sources.plugin.parameters.withArrayMixin

withArrayMixin(array)

"Array is the value of an array type parameter."

Note: This function appends passed data to existing values

fn spec.sources.plugin.parameters.withMap

withMap(map)

"Map is the value of a map type parameter."

fn spec.sources.plugin.parameters.withMapMixin

withMapMixin(map)

"Map is the value of a map type parameter."

Note: This function appends passed data to existing values

fn spec.sources.plugin.parameters.withName

withName(name)

"Name is the name identifying a parameter."

fn spec.sources.plugin.parameters.withString

withString(string)

"String_ is the value of a string type parameter."

obj spec.syncPolicy

"SyncPolicy controls when and how a sync will be performed"

fn spec.syncPolicy.withSyncOptions

withSyncOptions(syncOptions)

"Options allow you to specify whole app sync-options"

fn spec.syncPolicy.withSyncOptionsMixin

withSyncOptionsMixin(syncOptions)

"Options allow you to specify whole app sync-options"

Note: This function appends passed data to existing values

obj spec.syncPolicy.automated

"Automated will keep an application synced to the target revision"

fn spec.syncPolicy.automated.withAllowEmpty

withAllowEmpty(allowEmpty)

"AllowEmpty allows apps have zero live resources (default: false)"

fn spec.syncPolicy.automated.withPrune

withPrune(prune)

"Prune specifies whether to delete resources from the cluster that are not found in the sources anymore as part of automated sync (default: false)"

fn spec.syncPolicy.automated.withSelfHeal

withSelfHeal(selfHeal)

"SelfHeal specifies whether to revert resources back to their desired state upon modification in the cluster (default: false)"

obj spec.syncPolicy.managedNamespaceMetadata

"ManagedNamespaceMetadata controls metadata in the given namespace (if CreateNamespace=true)"

fn spec.syncPolicy.managedNamespaceMetadata.withAnnotations

withAnnotations(annotations)

fn spec.syncPolicy.managedNamespaceMetadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

Note: This function appends passed data to existing values

fn spec.syncPolicy.managedNamespaceMetadata.withLabels

withLabels(labels)

fn spec.syncPolicy.managedNamespaceMetadata.withLabelsMixin

withLabelsMixin(labels)

Note: This function appends passed data to existing values

obj spec.syncPolicy.retry

"Retry controls failed sync retry behavior"

fn spec.syncPolicy.retry.withLimit

withLimit(limit)

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

obj spec.syncPolicy.retry.backoff

"Backoff controls how to backoff on subsequent retries of failed syncs"

fn spec.syncPolicy.retry.backoff.withDuration

withDuration(duration)

"Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. \"2m\", \"1h\")"

fn spec.syncPolicy.retry.backoff.withFactor

withFactor(factor)

"Factor is a factor to multiply the base duration after each failed retry"

fn spec.syncPolicy.retry.backoff.withMaxDuration

withMaxDuration(maxDuration)

"MaxDuration is the maximum amount of time allowed for the backoff strategy"