2021-01-12 10:27:30 -08:00
apiVersion : apiextensions.k8s.io/v1
2019-12-19 09:50:18 +11:00
kind : CustomResourceDefinition
metadata :
labels :
app.kubernetes.io/name : applications.argoproj.io
app.kubernetes.io/part-of : argocd
name : applications.argoproj.io
spec :
group : argoproj.io
names :
kind : Application
2020-04-08 17:43:40 +02:00
listKind : ApplicationList
2019-12-19 09:50:18 +11:00
plural : applications
shortNames :
2020-04-08 17:43:40 +02:00
- app
- apps
singular : application
2019-12-19 09:50:18 +11:00
scope : Namespaced
2021-01-15 11:44:31 -08:00
versions :
2021-04-24 12:50:25 +02:00
- additionalPrinterColumns :
2021-01-15 11:44:31 -08:00
- jsonPath : .status.sync.status
name : Sync Status
type : string
- jsonPath : .status.health.status
name : Health Status
type : string
- jsonPath : .status.sync.revision
name : Revision
priority : 10
type : string
2021-04-24 12:50:25 +02:00
name : v1alpha1
2021-01-15 11:44:31 -08:00
schema :
openAPIV3Schema :
description : Application is a definition of Application resource.
properties :
apiVersion :
2021-12-15 11:15:02 +01:00
description : 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
2021-01-15 11:44:31 -08:00
type : string
kind :
2021-12-15 11:15:02 +01:00
description : 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
2021-01-15 11:44:31 -08:00
type : string
metadata :
type : object
operation :
2021-12-15 11:15:02 +01:00
description : Operation contains information about a requested or running
operation
2021-01-15 11:44:31 -08:00
properties :
info :
2021-04-24 12:50:25 +02:00
description : Info is a list of informational items for this operation
2021-01-15 11:44:31 -08:00
items :
2020-08-29 16:42:25 -04:00
properties :
2021-01-15 11:44:31 -08:00
name :
2020-08-29 16:42:25 -04:00
type : string
2021-01-15 11:44:31 -08:00
value :
2020-08-29 16:42:25 -04:00
type : string
2021-01-15 11:44:31 -08:00
required :
- name
- value
2020-08-29 16:42:25 -04:00
type : object
2021-01-15 11:44:31 -08:00
type : array
initiatedBy :
2021-12-15 11:15:02 +01:00
description : InitiatedBy contains information about who initiated
the operations
2021-01-15 11:44:31 -08:00
properties :
automated :
2021-12-15 11:15:02 +01:00
description : Automated is set to true if operation was initiated
automatically by the application controller.
2021-01-15 11:44:31 -08:00
type : boolean
username :
2021-12-15 11:15:02 +01:00
description : Username contains the name of a user who started
operation
2019-12-19 09:50:18 +11:00
type : string
2021-01-15 11:44:31 -08:00
type : object
retry :
2021-04-24 12:50:25 +02:00
description : Retry controls the strategy to apply if a sync fails
2021-01-15 11:44:31 -08:00
properties :
backoff :
2021-12-15 11:15:02 +01:00
description : Backoff controls how to backoff on subsequent retries
of failed syncs
2019-12-19 09:50:18 +11:00
properties :
2021-01-15 11:44:31 -08:00
duration :
2021-12-15 11:15:02 +01:00
description : Duration is the amount to back off. Default unit
is seconds, but could also be a duration (e.g. "2m", "1h")
2019-12-19 09:50:18 +11:00
type : string
2021-01-15 11:44:31 -08:00
factor :
2021-12-15 11:15:02 +01:00
description : Factor is a factor to multiply the base duration
after each failed retry
2021-01-15 11:44:31 -08:00
format : int64
type : integer
maxDuration :
2021-12-15 11:15:02 +01:00
description : MaxDuration is the maximum amount of time allowed
for the backoff strategy
2020-08-29 16:42:25 -04:00
type : string
2019-12-19 09:50:18 +11:00
type : object
2021-01-15 11:44:31 -08:00
limit :
2021-12-15 11:15:02 +01:00
description : Limit is the maximum number of attempts for retrying
a failed sync. If set to 0, no retries will be performed.
2021-01-15 11:44:31 -08:00
format : int64
type : integer
type : object
sync :
2021-04-24 12:50:25 +02:00
description : Sync contains parameters for the operation
2019-12-19 09:50:18 +11:00
properties :
2021-01-15 11:44:31 -08:00
dryRun :
2021-12-15 11:15:02 +01:00
description : DryRun specifies to perform a `kubectl apply --dry-run`
without actually performing the sync
2021-01-15 11:44:31 -08:00
type : boolean
manifests :
2021-12-15 11:15:02 +01:00
description : Manifests is an optional field that overrides sync
source with a local directory for development
2019-12-19 09:50:18 +11:00
items :
type : string
type : array
2021-01-15 11:44:31 -08:00
prune :
2021-12-15 11:15:02 +01:00
description : Prune specifies to delete resources from the cluster
that are no longer tracked in git
2021-01-15 11:44:31 -08:00
type : boolean
resources :
2021-12-15 11:15:02 +01:00
description : Resources describes which resources shall be part
of the sync
2021-01-15 11:44:31 -08:00
items :
description : SyncOperationResource contains resources to sync.
2020-08-29 16:42:25 -04:00
properties :
2021-01-15 11:44:31 -08:00
group :
2020-08-29 16:42:25 -04:00
type : string
2021-01-15 11:44:31 -08:00
kind :
type : string
name :
type : string
namespace :
2020-08-29 16:42:25 -04:00
type : string
2021-01-15 11:44:31 -08:00
required :
- kind
- name
2020-08-29 16:42:25 -04:00
type : object
2021-01-15 11:44:31 -08:00
type : array
2019-12-19 09:50:18 +11:00
revision :
2021-12-15 11:15:02 +01:00
description : 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.
2019-12-19 09:50:18 +11:00
type : string
source :
2021-12-15 11:15:02 +01:00
description : Source overrides the source definition set in the
application. This is typically set in a Rollback operation and
is nil during a Sync operation
2019-12-19 09:50:18 +11:00
properties :
chart :
2021-12-15 11:15:02 +01:00
description : Chart is a Helm chart name, and must be specified
for applications sourced from a Helm repo.
2019-12-19 09:50:18 +11:00
type : string
directory :
description : Directory holds path/directory specific options
properties :
2021-02-13 20:45:16 +01:00
exclude :
2021-12-15 11:15:02 +01:00
description : Exclude contains a glob pattern to match
paths against that should be explicitly excluded from
being used during manifest generation
2021-04-24 12:50:25 +02:00
type : string
include :
2021-12-15 11:15:02 +01:00
description : Include contains a glob pattern to match
paths against that should be explicitly included during
manifest generation
2021-02-13 20:45:16 +01:00
type : string
2019-12-19 09:50:18 +11:00
jsonnet :
2021-04-24 12:50:25 +02:00
description : Jsonnet holds options specific to Jsonnet
2019-12-19 09:50:18 +11:00
properties :
extVars :
2021-12-15 11:15:02 +01:00
description : ExtVars is a list of Jsonnet External
Variables
2019-12-19 09:50:18 +11:00
items :
2021-12-15 11:15:02 +01:00
description : JsonnetVar represents a variable to
be passed to jsonnet during manifest generation
2019-12-19 09:50:18 +11:00
properties :
code :
type : boolean
name :
type : string
value :
type : string
required :
2020-04-08 17:43:40 +02:00
- name
- value
2019-12-19 09:50:18 +11:00
type : object
type : array
2020-08-29 16:42:25 -04:00
libs :
description : Additional library search dirs
items :
type : string
type : array
2019-12-19 09:50:18 +11:00
tlas :
description : TLAS is a list of Jsonnet Top-level Arguments
items :
2021-12-15 11:15:02 +01:00
description : JsonnetVar represents a variable to
be passed to jsonnet during manifest generation
2019-12-19 09:50:18 +11:00
properties :
code :
type : boolean
name :
type : string
value :
type : string
required :
2020-04-08 17:43:40 +02:00
- name
- value
2019-12-19 09:50:18 +11:00
type : object
type : array
type : object
recurse :
2021-12-15 11:15:02 +01:00
description : Recurse specifies whether to scan a directory
recursively for manifests
2019-12-19 09:50:18 +11:00
type : boolean
type : object
helm :
description : Helm holds helm specific options
properties :
2020-04-08 17:43:40 +02:00
fileParameters :
2021-12-15 11:15:02 +01:00
description : FileParameters are file parameters to the
helm template
2020-04-08 17:43:40 +02:00
items :
2021-12-15 11:15:02 +01:00
description : HelmFileParameter is a file parameter that's
passed to helm template during manifest generation
2020-04-08 17:43:40 +02:00
properties :
name :
2021-04-24 12:50:25 +02:00
description : Name is the name of the Helm parameter
2020-04-08 17:43:40 +02:00
type : string
path :
2021-12-15 11:15:02 +01:00
description : Path is the path to the file containing
the values for the Helm parameter
2020-04-08 17:43:40 +02:00
type : string
type : object
type : array
2019-12-19 09:50:18 +11:00
parameters :
2021-12-15 11:15:02 +01:00
description : Parameters is a list of Helm parameters which
are passed to the helm template command upon manifest
generation
2019-12-19 09:50:18 +11:00
items :
2021-12-15 11:15:02 +01:00
description : HelmParameter is a parameter that's passed
to helm template during manifest generation
2019-12-19 09:50:18 +11:00
properties :
forceString :
2021-12-15 11:15:02 +01:00
description : ForceString determines whether to tell
Helm to interpret booleans and numbers as strings
2019-12-19 09:50:18 +11:00
type : boolean
name :
2021-04-24 12:50:25 +02:00
description : Name is the name of the Helm parameter
2019-12-19 09:50:18 +11:00
type : string
value :
2021-04-24 12:50:25 +02:00
description : Value is the value for the Helm parameter
2019-12-19 09:50:18 +11:00
type : string
type : object
type : array
2021-12-15 11:15:02 +01:00
passCredentials :
description : PassCredentials pass credentials to all domains
(Helm's --pass-credentials)
type : boolean
2019-12-19 09:50:18 +11:00
releaseName :
2021-12-15 11:15:02 +01:00
description : ReleaseName is the Helm release name to use.
If omitted it will use the application name
2019-12-19 09:50:18 +11:00
type : string
valueFiles :
2021-12-15 11:15:02 +01:00
description : ValuesFiles is a list of Helm value files
to use when generating a template
2019-12-19 09:50:18 +11:00
items :
type : string
type : array
values :
2021-12-15 11:15:02 +01:00
description : Values specifies Helm values to be passed
to helm template, typically defined as a block
2019-12-19 09:50:18 +11:00
type : string
2020-10-25 04:55:44 +00:00
version :
2021-12-15 11:15:02 +01:00
description : Version is the Helm version to use for templating
(either "2" or "3")
2020-10-25 04:55:44 +00:00
type : string
2019-12-19 09:50:18 +11:00
type : object
ksonnet :
description : Ksonnet holds ksonnet specific options
properties :
environment :
2021-12-15 11:15:02 +01:00
description : Environment is a ksonnet application environment
name
2019-12-19 09:50:18 +11:00
type : string
parameters :
2021-12-15 11:15:02 +01:00
description : Parameters are a list of ksonnet component
parameter override values
2019-12-19 09:50:18 +11:00
items :
2021-12-15 11:15:02 +01:00
description : KsonnetParameter is a ksonnet component
parameter
2019-12-19 09:50:18 +11:00
properties :
component :
type : string
name :
type : string
value :
type : string
required :
2020-04-08 17:43:40 +02:00
- name
- value
2019-12-19 09:50:18 +11:00
type : object
type : array
type : object
kustomize :
description : Kustomize holds kustomize specific options
properties :
2021-02-13 20:45:16 +01:00
commonAnnotations :
additionalProperties :
type : string
2021-12-15 11:15:02 +01:00
description : CommonAnnotations is a list of additional
annotations to add to rendered manifests
2021-02-13 20:45:16 +01:00
type : object
2019-12-19 09:50:18 +11:00
commonLabels :
additionalProperties :
type : string
2021-12-15 11:15:02 +01:00
description : CommonLabels is a list of additional labels
to add to rendered manifests
2019-12-19 09:50:18 +11:00
type : object
2021-08-26 10:42:47 -03:00
forceCommonAnnotations :
2021-12-15 11:15:02 +01:00
description : ForceCommonAnnotations specifies whether
to force applying common annotations to resources for
Kustomize apps
2021-08-26 10:42:47 -03:00
type : boolean
forceCommonLabels :
2021-12-15 11:15:02 +01:00
description : ForceCommonLabels specifies whether to force
applying common labels to resources for Kustomize apps
2021-08-26 10:42:47 -03:00
type : boolean
2019-12-19 09:50:18 +11:00
images :
2021-12-15 11:15:02 +01:00
description : Images is a list of Kustomize image override
specifications
2019-12-19 09:50:18 +11:00
items :
2021-12-15 11:15:02 +01:00
description : KustomizeImage represents a Kustomize image
definition in the format [old_image_name=]<image_name>:<image_tag>
2019-12-19 09:50:18 +11:00
type : string
type : array
namePrefix :
2021-12-15 11:15:02 +01:00
description : NamePrefix is a prefix appended to resources
for Kustomize apps
2020-04-08 17:43:40 +02:00
type : string
nameSuffix :
2021-12-15 11:15:02 +01:00
description : NameSuffix is a suffix appended to resources
for Kustomize apps
2019-12-19 09:50:18 +11:00
type : string
2020-05-14 04:16:36 +02:00
version :
2021-12-15 11:15:02 +01:00
description : Version controls which version of Kustomize
to use for rendering manifests
2020-05-14 04:16:36 +02:00
type : string
2019-12-19 09:50:18 +11:00
type : object
path :
2021-12-15 11:15:02 +01:00
description : Path is a directory path within the Git repository,
and is only valid for applications sourced from Git.
2019-12-19 09:50:18 +11:00
type : string
plugin :
2021-12-15 11:15:02 +01:00
description : ConfigManagementPlugin holds config management
plugin specific options
2019-12-19 09:50:18 +11:00
properties :
env :
2021-04-24 12:50:25 +02:00
description : Env is a list of environment variable entries
2019-12-19 09:50:18 +11:00
items :
2021-12-15 11:15:02 +01:00
description : EnvEntry represents an entry in the application's
environment
2019-12-19 09:50:18 +11:00
properties :
name :
2021-12-15 11:15:02 +01:00
description : Name is the name of the variable, usually
expressed in uppercase
2019-12-19 09:50:18 +11:00
type : string
value :
2021-04-24 12:50:25 +02:00
description : Value is the value of the variable
2019-12-19 09:50:18 +11:00
type : string
required :
2020-04-08 17:43:40 +02:00
- name
- value
2019-12-19 09:50:18 +11:00
type : object
type : array
name :
type : string
type : object
repoURL :
2021-12-15 11:15:02 +01:00
description : RepoURL is the URL to the repository (Git or
Helm) that contains the application manifests
2019-12-19 09:50:18 +11:00
type : string
targetRevision :
2021-12-15 11:15:02 +01:00
description : 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.
2019-12-19 09:50:18 +11:00
type : string
required :
2020-04-08 17:43:40 +02:00
- repoURL
2019-12-19 09:50:18 +11:00
type : object
2021-01-15 11:44:31 -08:00
syncOptions :
description : SyncOptions provide per-sync sync-options, e.g. Validate=false
items :
type : string
type : array
syncStrategy :
description : SyncStrategy describes how to perform the sync
properties :
apply :
2021-12-15 11:15:02 +01:00
description : Apply will perform a `kubectl apply` to perform
the sync.
2020-06-24 17:01:53 +02:00
properties :
2021-01-15 11:44:31 -08:00
force :
2021-12-15 11:15:02 +01:00
description : 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.
2021-01-15 11:44:31 -08:00
type : boolean
type : object
hook :
2021-12-15 11:15:02 +01:00
description : Hook will submit any referenced resources to
perform the sync. This is the default strategy
2021-01-15 11:44:31 -08:00
properties :
force :
2021-12-15 11:15:02 +01:00
description : 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.
2021-01-15 11:44:31 -08:00
type : boolean
2020-06-24 17:01:53 +02:00
type : object
2021-01-15 11:44:31 -08:00
type : object
type : object
type : object
spec :
2021-12-15 11:15:02 +01:00
description : ApplicationSpec represents desired application state. Contains
link to repository with application definition and additional parameters
link definition revision.
2021-01-15 11:44:31 -08:00
properties :
destination :
2021-12-15 11:15:02 +01:00
description : Destination is a reference to the target Kubernetes server
and namespace
2021-01-15 11:44:31 -08:00
properties :
name :
2021-12-15 11:15:02 +01:00
description : Name is an alternate way of specifying the target
cluster by its symbolic name
2021-01-15 11:44:31 -08:00
type : string
namespace :
2021-12-15 11:15:02 +01:00
description : 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
2021-01-15 11:44:31 -08:00
type : string
server :
2021-12-15 11:15:02 +01:00
description : Server specifies the URL of the target cluster and
must be set to the Kubernetes control plane API
2021-01-15 11:44:31 -08:00
type : string
type : object
ignoreDifferences :
2021-12-15 11:15:02 +01:00
description : IgnoreDifferences is a list of resources and their fields
which should be ignored during comparison
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : ResourceIgnoreDifferences contains resource filter
and list of json paths which should be ignored during comparison
with live state.
2021-01-15 11:44:31 -08:00
properties :
group :
type : string
2021-08-26 10:42:47 -03:00
jqPathExpressions :
items :
type : string
type : array
2021-01-15 11:44:31 -08:00
jsonPointers :
items :
type : string
2020-06-24 17:01:53 +02:00
type : array
2021-01-15 11:44:31 -08:00
kind :
type : string
2021-12-15 11:15:02 +01:00
managedFieldsManagers :
description : 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
items :
type : string
type : array
2021-01-15 11:44:31 -08:00
name :
type : string
namespace :
type : string
required :
- kind
type : object
type : array
info :
2021-12-15 11:15:02 +01:00
description : Info contains a list of information (URLs, email addresses,
and plain text) that relates to the application
2021-01-15 11:44:31 -08:00
items :
properties :
name :
type : string
value :
type : string
required :
- name
- value
type : object
type : array
project :
2021-12-15 11:15:02 +01:00
description : Project is a reference to the project this application
belongs to. The empty string means that application belongs to the
'default' project.
2021-01-15 11:44:31 -08:00
type : string
revisionHistoryLimit :
2021-12-15 11:15:02 +01:00
description : 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.
2021-01-15 11:44:31 -08:00
format : int64
type : integer
source :
2021-12-15 11:15:02 +01:00
description : Source is a reference to the location of the application's
manifests or chart
2021-01-15 11:44:31 -08:00
properties :
chart :
2021-12-15 11:15:02 +01:00
description : Chart is a Helm chart name, and must be specified
for applications sourced from a Helm repo.
2021-01-15 11:44:31 -08:00
type : string
directory :
description : Directory holds path/directory specific options
properties :
2021-02-13 20:45:16 +01:00
exclude :
2021-12-15 11:15:02 +01:00
description : Exclude contains a glob pattern to match paths
against that should be explicitly excluded from being used
during manifest generation
2021-04-24 12:50:25 +02:00
type : string
include :
2021-12-15 11:15:02 +01:00
description : Include contains a glob pattern to match paths
against that should be explicitly included during manifest
generation
2021-02-13 20:45:16 +01:00
type : string
2021-01-15 11:44:31 -08:00
jsonnet :
2021-04-24 12:50:25 +02:00
description : Jsonnet holds options specific to Jsonnet
2021-01-15 11:44:31 -08:00
properties :
extVars :
description : ExtVars is a list of Jsonnet External Variables
items :
2021-12-15 11:15:02 +01:00
description : JsonnetVar represents a variable to be
passed to jsonnet during manifest generation
2019-12-19 09:50:18 +11:00
properties :
2021-01-15 11:44:31 -08:00
code :
2019-12-19 09:50:18 +11:00
type : boolean
2021-01-15 11:44:31 -08:00
name :
2020-10-25 04:55:44 +00:00
type : string
2021-01-15 11:44:31 -08:00
value :
2019-12-19 09:50:18 +11:00
type : string
2021-01-15 11:44:31 -08:00
required :
- name
- value
2019-12-19 09:50:18 +11:00
type : object
2021-01-15 11:44:31 -08:00
type : array
libs :
description : Additional library search dirs
items :
type : string
type : array
tlas :
description : TLAS is a list of Jsonnet Top-level Arguments
items :
2021-12-15 11:15:02 +01:00
description : JsonnetVar represents a variable to be
passed to jsonnet during manifest generation
2019-12-19 09:50:18 +11:00
properties :
2021-01-15 11:44:31 -08:00
code :
type : boolean
name :
2019-12-19 09:50:18 +11:00
type : string
2021-01-15 11:44:31 -08:00
value :
2020-05-14 04:16:36 +02:00
type : string
2021-01-15 11:44:31 -08:00
required :
- name
- value
2019-12-19 09:50:18 +11:00
type : object
2021-01-15 11:44:31 -08:00
type : array
type : object
recurse :
2021-12-15 11:15:02 +01:00
description : Recurse specifies whether to scan a directory
recursively for manifests
2021-01-15 11:44:31 -08:00
type : boolean
type : object
helm :
description : Helm holds helm specific options
properties :
fileParameters :
2021-12-15 11:15:02 +01:00
description : FileParameters are file parameters to the helm
template
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : HelmFileParameter is a file parameter that's
passed to helm template during manifest generation
2021-01-15 11:44:31 -08:00
properties :
name :
2021-04-24 12:50:25 +02:00
description : Name is the name of the Helm parameter
2021-01-15 11:44:31 -08:00
type : string
2019-12-19 09:50:18 +11:00
path :
2021-12-15 11:15:02 +01:00
description : Path is the path to the file containing
the values for the Helm parameter
2019-12-19 09:50:18 +11:00
type : string
2021-01-15 11:44:31 -08:00
type : object
type : array
parameters :
2021-12-15 11:15:02 +01:00
description : Parameters is a list of Helm parameters which
are passed to the helm template command upon manifest generation
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : HelmParameter is a parameter that's passed
to helm template during manifest generation
2021-01-15 11:44:31 -08:00
properties :
forceString :
2021-12-15 11:15:02 +01:00
description : ForceString determines whether to tell
Helm to interpret booleans and numbers as strings
2021-01-15 11:44:31 -08:00
type : boolean
name :
2021-04-24 12:50:25 +02:00
description : Name is the name of the Helm parameter
2021-01-15 11:44:31 -08:00
type : string
value :
2021-04-24 12:50:25 +02:00
description : Value is the value for the Helm parameter
2021-01-15 11:44:31 -08:00
type : string
type : object
type : array
2021-12-15 11:15:02 +01:00
passCredentials :
description : PassCredentials pass credentials to all domains
(Helm's --pass-credentials)
type : boolean
2021-01-15 11:44:31 -08:00
releaseName :
2021-12-15 11:15:02 +01:00
description : ReleaseName is the Helm release name to use.
If omitted it will use the application name
2021-01-15 11:44:31 -08:00
type : string
valueFiles :
2021-12-15 11:15:02 +01:00
description : ValuesFiles is a list of Helm value files to
use when generating a template
2021-01-15 11:44:31 -08:00
items :
type : string
type : array
values :
2021-12-15 11:15:02 +01:00
description : Values specifies Helm values to be passed to
helm template, typically defined as a block
2021-01-15 11:44:31 -08:00
type : string
version :
2021-12-15 11:15:02 +01:00
description : Version is the Helm version to use for templating
(either "2" or "3")
2021-01-15 11:44:31 -08:00
type : string
type : object
ksonnet :
description : Ksonnet holds ksonnet specific options
properties :
environment :
2021-12-15 11:15:02 +01:00
description : Environment is a ksonnet application environment
name
2021-01-15 11:44:31 -08:00
type : string
parameters :
2021-12-15 11:15:02 +01:00
description : Parameters are a list of ksonnet component parameter
override values
2021-01-15 11:44:31 -08:00
items :
description : KsonnetParameter is a ksonnet component parameter
properties :
component :
2019-12-19 09:50:18 +11:00
type : string
2021-01-15 11:44:31 -08:00
name :
type : string
value :
2019-12-19 09:50:18 +11:00
type : string
required :
2021-01-15 11:44:31 -08:00
- name
- value
2019-12-19 09:50:18 +11:00
type : object
2021-01-15 11:44:31 -08:00
type : array
type : object
kustomize :
description : Kustomize holds kustomize specific options
properties :
2021-02-13 20:45:16 +01:00
commonAnnotations :
additionalProperties :
type : string
2021-12-15 11:15:02 +01:00
description : CommonAnnotations is a list of additional annotations
to add to rendered manifests
2021-02-13 20:45:16 +01:00
type : object
2021-01-15 11:44:31 -08:00
commonLabels :
additionalProperties :
type : string
2021-12-15 11:15:02 +01:00
description : CommonLabels is a list of additional labels to
add to rendered manifests
2021-01-15 11:44:31 -08:00
type : object
2021-08-26 10:42:47 -03:00
forceCommonAnnotations :
2021-12-15 11:15:02 +01:00
description : ForceCommonAnnotations specifies whether to force
applying common annotations to resources for Kustomize apps
2021-08-26 10:42:47 -03:00
type : boolean
forceCommonLabels :
2021-12-15 11:15:02 +01:00
description : ForceCommonLabels specifies whether to force
applying common labels to resources for Kustomize apps
2021-08-26 10:42:47 -03:00
type : boolean
2021-01-15 11:44:31 -08:00
images :
2021-12-15 11:15:02 +01:00
description : Images is a list of Kustomize image override
specifications
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : KustomizeImage represents a Kustomize image
definition in the format [old_image_name=]<image_name>:<image_tag>
2021-01-15 11:44:31 -08:00
type : string
type : array
namePrefix :
2021-12-15 11:15:02 +01:00
description : NamePrefix is a prefix appended to resources
for Kustomize apps
2021-01-15 11:44:31 -08:00
type : string
nameSuffix :
2021-12-15 11:15:02 +01:00
description : NameSuffix is a suffix appended to resources
for Kustomize apps
2021-01-15 11:44:31 -08:00
type : string
version :
2021-12-15 11:15:02 +01:00
description : Version controls which version of Kustomize to
use for rendering manifests
2021-01-15 11:44:31 -08:00
type : string
type : object
path :
2021-12-15 11:15:02 +01:00
description : Path is a directory path within the Git repository,
and is only valid for applications sourced from Git.
2021-01-15 11:44:31 -08:00
type : string
plugin :
2021-12-15 11:15:02 +01:00
description : ConfigManagementPlugin holds config management plugin
specific options
2021-01-15 11:44:31 -08:00
properties :
env :
2021-04-24 12:50:25 +02:00
description : Env is a list of environment variable entries
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : EnvEntry represents an entry in the application's
environment
2019-12-19 09:50:18 +11:00
properties :
2021-01-15 11:44:31 -08:00
name :
2021-12-15 11:15:02 +01:00
description : Name is the name of the variable, usually
expressed in uppercase
2021-01-15 11:44:31 -08:00
type : string
value :
2021-04-24 12:50:25 +02:00
description : Value is the value of the variable
2021-01-15 11:44:31 -08:00
type : string
required :
- name
- value
2019-12-19 09:50:18 +11:00
type : object
2021-01-15 11:44:31 -08:00
type : array
name :
type : string
type : object
repoURL :
2021-12-15 11:15:02 +01:00
description : RepoURL is the URL to the repository (Git or Helm)
that contains the application manifests
2021-01-15 11:44:31 -08:00
type : string
targetRevision :
2021-12-15 11:15:02 +01:00
description : 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.
2021-01-15 11:44:31 -08:00
type : string
required :
- repoURL
type : object
syncPolicy :
2021-04-24 12:50:25 +02:00
description : SyncPolicy controls when and how a sync will be performed
2021-01-15 11:44:31 -08:00
properties :
automated :
2021-12-15 11:15:02 +01:00
description : Automated will keep an application synced to the
target revision
2021-01-15 11:44:31 -08:00
properties :
allowEmpty :
2021-12-15 11:15:02 +01:00
description : 'AllowEmpty allows apps have zero live resources
(default : false )'
2021-01-15 11:44:31 -08:00
type : boolean
prune :
2021-12-15 11:15:02 +01:00
description : 'Prune specifies whether to delete resources
from the cluster that are not found in the sources anymore
as part of automated sync (default : false )'
2021-01-15 11:44:31 -08:00
type : boolean
selfHeal :
2021-12-15 11:15:02 +01:00
description : 'SelfHeal specifes whether to revert resources
back to their desired state upon modification in the cluster
(default : false )'
2021-01-15 11:44:31 -08:00
type : boolean
type : object
retry :
description : Retry controls failed sync retry behavior
properties :
backoff :
2021-12-15 11:15:02 +01:00
description : Backoff controls how to backoff on subsequent
retries of failed syncs
2019-12-19 09:50:18 +11:00
properties :
2021-01-15 11:44:31 -08:00
duration :
2021-12-15 11:15:02 +01:00
description : Duration is the amount to back off. Default
unit is seconds, but could also be a duration (e.g.
"2m" , "1h" )
2019-12-19 09:50:18 +11:00
type : string
2021-01-15 11:44:31 -08:00
factor :
2021-12-15 11:15:02 +01:00
description : Factor is a factor to multiply the base duration
after each failed retry
2021-01-15 11:44:31 -08:00
format : int64
type : integer
maxDuration :
2021-12-15 11:15:02 +01:00
description : MaxDuration is the maximum amount of time
allowed for the backoff strategy
2019-12-19 09:50:18 +11:00
type : string
type : object
2021-01-15 11:44:31 -08:00
limit :
2021-12-15 11:15:02 +01:00
description : Limit is the maximum number of attempts for retrying
a failed sync. If set to 0, no retries will be performed.
2021-01-15 11:44:31 -08:00
format : int64
type : integer
type : object
syncOptions :
description : Options allow you to specify whole app sync-options
items :
type : string
type : array
type : object
required :
- destination
- project
- source
type : object
status :
2021-04-24 12:50:25 +02:00
description : ApplicationStatus contains status information for the application
2021-01-15 11:44:31 -08:00
properties :
conditions :
2021-12-15 11:15:02 +01:00
description : Conditions is a list of currently observed application
conditions
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : ApplicationCondition contains details about an application
condition, which is usally an error or warning
2021-01-15 11:44:31 -08:00
properties :
lastTransitionTime :
2021-12-15 11:15:02 +01:00
description : LastTransitionTime is the time the condition was
last observed
2021-01-15 11:44:31 -08:00
format : date-time
type : string
message :
2021-12-15 11:15:02 +01:00
description : Message contains human-readable message indicating
details about condition
2021-01-15 11:44:31 -08:00
type : string
type :
description : Type is an application condition type
type : string
required :
- message
- type
type : object
type : array
health :
2021-12-15 11:15:02 +01:00
description : Health contains information about the application's current
health status
2021-01-15 11:44:31 -08:00
properties :
message :
2021-12-15 11:15:02 +01:00
description : Message is a human-readable informational message
describing the health status
2021-01-15 11:44:31 -08:00
type : string
status :
2021-12-15 11:15:02 +01:00
description : Status holds the status code of the application or
resource
2021-01-15 11:44:31 -08:00
type : string
type : object
history :
2021-12-15 11:15:02 +01:00
description : History contains information about the application's
sync history
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : RevisionHistory contains history information about
a previous sync
2021-01-15 11:44:31 -08:00
properties :
deployStartedAt :
2021-12-15 11:15:02 +01:00
description : DeployStartedAt holds the time the sync operation
started
2021-01-15 11:44:31 -08:00
format : date-time
type : string
deployedAt :
2021-04-24 12:50:25 +02:00
description : DeployedAt holds the time the sync operation completed
2021-01-15 11:44:31 -08:00
format : date-time
type : string
id :
description : ID is an auto incrementing identifier of the RevisionHistory
format : int64
type : integer
2019-12-19 09:50:18 +11:00
revision :
2021-12-15 11:15:02 +01:00
description : Revision holds the revision the sync was performed
against
2019-12-19 09:50:18 +11:00
type : string
source :
2021-12-15 11:15:02 +01:00
description : Source is a reference to the application source
used for the sync operation
2019-12-19 09:50:18 +11:00
properties :
chart :
2021-12-15 11:15:02 +01:00
description : Chart is a Helm chart name, and must be specified
for applications sourced from a Helm repo.
2019-12-19 09:50:18 +11:00
type : string
directory :
description : Directory holds path/directory specific options
properties :
2021-02-13 20:45:16 +01:00
exclude :
2021-12-15 11:15:02 +01:00
description : Exclude contains a glob pattern to match
paths against that should be explicitly excluded from
being used during manifest generation
2021-04-24 12:50:25 +02:00
type : string
include :
2021-12-15 11:15:02 +01:00
description : Include contains a glob pattern to match
paths against that should be explicitly included during
manifest generation
2021-02-13 20:45:16 +01:00
type : string
2019-12-19 09:50:18 +11:00
jsonnet :
2021-04-24 12:50:25 +02:00
description : Jsonnet holds options specific to Jsonnet
2019-12-19 09:50:18 +11:00
properties :
extVars :
2021-12-15 11:15:02 +01:00
description : ExtVars is a list of Jsonnet External
Variables
2019-12-19 09:50:18 +11:00
items :
2021-12-15 11:15:02 +01:00
description : JsonnetVar represents a variable
to be passed to jsonnet during manifest generation
2019-12-19 09:50:18 +11:00
properties :
code :
type : boolean
name :
type : string
value :
type : string
required :
2020-04-08 17:43:40 +02:00
- name
- value
2019-12-19 09:50:18 +11:00
type : object
type : array
2020-08-29 16:42:25 -04:00
libs :
description : Additional library search dirs
items :
type : string
type : array
2019-12-19 09:50:18 +11:00
tlas :
2021-12-15 11:15:02 +01:00
description : TLAS is a list of Jsonnet Top-level
Arguments
2019-12-19 09:50:18 +11:00
items :
2021-12-15 11:15:02 +01:00
description : JsonnetVar represents a variable
to be passed to jsonnet during manifest generation
2019-12-19 09:50:18 +11:00
properties :
code :
type : boolean
name :
type : string
value :
type : string
required :
2020-04-08 17:43:40 +02:00
- name
- value
2019-12-19 09:50:18 +11:00
type : object
type : array
type : object
recurse :
2021-12-15 11:15:02 +01:00
description : Recurse specifies whether to scan a directory
recursively for manifests
2019-12-19 09:50:18 +11:00
type : boolean
type : object
helm :
description : Helm holds helm specific options
properties :
2020-04-08 17:43:40 +02:00
fileParameters :
2021-12-15 11:15:02 +01:00
description : FileParameters are file parameters to the
helm template
2020-04-08 17:43:40 +02:00
items :
2021-12-15 11:15:02 +01:00
description : HelmFileParameter is a file parameter
that's passed to helm template during manifest generation
2020-04-08 17:43:40 +02:00
properties :
name :
2021-04-24 12:50:25 +02:00
description : Name is the name of the Helm parameter
2020-04-08 17:43:40 +02:00
type : string
path :
2021-12-15 11:15:02 +01:00
description : Path is the path to the file containing
the values for the Helm parameter
2020-04-08 17:43:40 +02:00
type : string
type : object
type : array
2019-12-19 09:50:18 +11:00
parameters :
2021-12-15 11:15:02 +01:00
description : Parameters is a list of Helm parameters
which are passed to the helm template command upon
manifest generation
2019-12-19 09:50:18 +11:00
items :
2021-12-15 11:15:02 +01:00
description : HelmParameter is a parameter that's passed
to helm template during manifest generation
2019-12-19 09:50:18 +11:00
properties :
forceString :
2021-12-15 11:15:02 +01:00
description : ForceString determines whether to
tell Helm to interpret booleans and numbers
as strings
2019-12-19 09:50:18 +11:00
type : boolean
name :
2021-04-24 12:50:25 +02:00
description : Name is the name of the Helm parameter
2019-12-19 09:50:18 +11:00
type : string
value :
2021-04-24 12:50:25 +02:00
description : Value is the value for the Helm parameter
2019-12-19 09:50:18 +11:00
type : string
type : object
type : array
2021-12-15 11:15:02 +01:00
passCredentials :
description : PassCredentials pass credentials to all
domains (Helm's --pass-credentials)
type : boolean
2019-12-19 09:50:18 +11:00
releaseName :
2021-12-15 11:15:02 +01:00
description : ReleaseName is the Helm release name to
use. If omitted it will use the application name
2019-12-19 09:50:18 +11:00
type : string
valueFiles :
2021-12-15 11:15:02 +01:00
description : ValuesFiles is a list of Helm value files
to use when generating a template
2019-12-19 09:50:18 +11:00
items :
type : string
type : array
values :
2021-12-15 11:15:02 +01:00
description : Values specifies Helm values to be passed
to helm template, typically defined as a block
2019-12-19 09:50:18 +11:00
type : string
2020-10-25 04:55:44 +00:00
version :
2021-12-15 11:15:02 +01:00
description : Version is the Helm version to use for
templating (either "2" or "3")
2020-10-25 04:55:44 +00:00
type : string
2019-12-19 09:50:18 +11:00
type : object
ksonnet :
description : Ksonnet holds ksonnet specific options
properties :
environment :
2021-12-15 11:15:02 +01:00
description : Environment is a ksonnet application environment
name
2019-12-19 09:50:18 +11:00
type : string
parameters :
2021-12-15 11:15:02 +01:00
description : Parameters are a list of ksonnet component
parameter override values
2019-12-19 09:50:18 +11:00
items :
2021-12-15 11:15:02 +01:00
description : KsonnetParameter is a ksonnet component
parameter
2019-12-19 09:50:18 +11:00
properties :
component :
type : string
name :
type : string
value :
type : string
required :
2020-04-08 17:43:40 +02:00
- name
- value
2019-12-19 09:50:18 +11:00
type : object
type : array
type : object
kustomize :
description : Kustomize holds kustomize specific options
properties :
2021-02-13 20:45:16 +01:00
commonAnnotations :
additionalProperties :
type : string
2021-12-15 11:15:02 +01:00
description : CommonAnnotations is a list of additional
annotations to add to rendered manifests
2021-02-13 20:45:16 +01:00
type : object
2019-12-19 09:50:18 +11:00
commonLabels :
additionalProperties :
type : string
2021-12-15 11:15:02 +01:00
description : CommonLabels is a list of additional labels
to add to rendered manifests
2019-12-19 09:50:18 +11:00
type : object
2021-08-26 10:42:47 -03:00
forceCommonAnnotations :
2021-12-15 11:15:02 +01:00
description : ForceCommonAnnotations specifies whether
to force applying common annotations to resources
for Kustomize apps
2021-08-26 10:42:47 -03:00
type : boolean
forceCommonLabels :
2021-12-15 11:15:02 +01:00
description : ForceCommonLabels specifies whether to
force applying common labels to resources for Kustomize
apps
2021-08-26 10:42:47 -03:00
type : boolean
2019-12-19 09:50:18 +11:00
images :
2021-12-15 11:15:02 +01:00
description : Images is a list of Kustomize image override
specifications
2019-12-19 09:50:18 +11:00
items :
2021-12-15 11:15:02 +01:00
description : KustomizeImage represents a Kustomize
image definition in the format [old_image_name=]<image_name>:<image_tag>
2019-12-19 09:50:18 +11:00
type : string
type : array
namePrefix :
2021-12-15 11:15:02 +01:00
description : NamePrefix is a prefix appended to resources
for Kustomize apps
2020-04-08 17:43:40 +02:00
type : string
nameSuffix :
2021-12-15 11:15:02 +01:00
description : NameSuffix is a suffix appended to resources
for Kustomize apps
2019-12-19 09:50:18 +11:00
type : string
2020-05-14 04:16:36 +02:00
version :
2021-12-15 11:15:02 +01:00
description : Version controls which version of Kustomize
to use for rendering manifests
2020-05-14 04:16:36 +02:00
type : string
2019-12-19 09:50:18 +11:00
type : object
path :
2021-12-15 11:15:02 +01:00
description : Path is a directory path within the Git repository,
and is only valid for applications sourced from Git.
2019-12-19 09:50:18 +11:00
type : string
plugin :
2021-12-15 11:15:02 +01:00
description : ConfigManagementPlugin holds config management
plugin specific options
2019-12-19 09:50:18 +11:00
properties :
env :
2021-04-24 12:50:25 +02:00
description : Env is a list of environment variable entries
2019-12-19 09:50:18 +11:00
items :
2021-12-15 11:15:02 +01:00
description : EnvEntry represents an entry in the application's
environment
2019-12-19 09:50:18 +11:00
properties :
name :
2021-12-15 11:15:02 +01:00
description : Name is the name of the variable,
usually expressed in uppercase
2019-12-19 09:50:18 +11:00
type : string
value :
2021-04-24 12:50:25 +02:00
description : Value is the value of the variable
2019-12-19 09:50:18 +11:00
type : string
required :
2020-04-08 17:43:40 +02:00
- name
- value
2019-12-19 09:50:18 +11:00
type : object
type : array
name :
type : string
type : object
repoURL :
2021-12-15 11:15:02 +01:00
description : RepoURL is the URL to the repository (Git or
Helm) that contains the application manifests
2019-12-19 09:50:18 +11:00
type : string
targetRevision :
2021-12-15 11:15:02 +01:00
description : 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.
2019-12-19 09:50:18 +11:00
type : string
required :
2020-04-08 17:43:40 +02:00
- repoURL
2019-12-19 09:50:18 +11:00
type : object
required :
2021-01-15 11:44:31 -08:00
- deployedAt
- id
2020-04-08 17:43:40 +02:00
- revision
2019-12-19 09:50:18 +11:00
type : object
2021-01-15 11:44:31 -08:00
type : array
observedAt :
2021-12-15 11:15:02 +01:00
description : 'ObservedAt indicates when the application state was
updated without querying latest git state Deprecated : controller
no longer updates ObservedAt field'
2021-01-15 11:44:31 -08:00
format : date-time
type : string
operationState :
2021-12-15 11:15:02 +01:00
description : OperationState contains information about any ongoing
operations, such as a sync
2019-12-19 09:50:18 +11:00
properties :
2021-01-15 11:44:31 -08:00
finishedAt :
description : FinishedAt contains time of operation completion
format : date-time
2019-12-19 09:50:18 +11:00
type : string
2021-01-15 11:44:31 -08:00
message :
2021-12-15 11:15:02 +01:00
description : Message holds any pertinent messages when attempting
to perform operation (typically errors).
2019-12-19 09:50:18 +11:00
type : string
2021-01-15 11:44:31 -08:00
operation :
description : Operation is the original requested operation
properties :
info :
2021-12-15 11:15:02 +01:00
description : Info is a list of informational items for this
operation
2021-01-15 11:44:31 -08:00
items :
2019-12-19 09:50:18 +11:00
properties :
2021-01-15 11:44:31 -08:00
name :
type : string
value :
type : string
required :
- name
- value
type : object
type : array
initiatedBy :
2021-12-15 11:15:02 +01:00
description : InitiatedBy contains information about who initiated
the operations
2021-01-15 11:44:31 -08:00
properties :
automated :
2021-12-15 11:15:02 +01:00
description : Automated is set to true if operation was
initiated automatically by the application controller.
2021-01-15 11:44:31 -08:00
type : boolean
username :
2021-12-15 11:15:02 +01:00
description : Username contains the name of a user who
started operation
2021-01-15 11:44:31 -08:00
type : string
type : object
retry :
2021-12-15 11:15:02 +01:00
description : Retry controls the strategy to apply if a sync
fails
2021-01-15 11:44:31 -08:00
properties :
backoff :
2021-12-15 11:15:02 +01:00
description : Backoff controls how to backoff on subsequent
retries of failed syncs
2021-01-15 11:44:31 -08:00
properties :
duration :
2021-12-15 11:15:02 +01:00
description : Duration is the amount to back off. Default
unit is seconds, but could also be a duration (e.g.
"2m" , "1h" )
2021-01-15 11:44:31 -08:00
type : string
factor :
2021-12-15 11:15:02 +01:00
description : Factor is a factor to multiply the base
duration after each failed retry
2021-01-15 11:44:31 -08:00
format : int64
type : integer
maxDuration :
2021-12-15 11:15:02 +01:00
description : MaxDuration is the maximum amount of
time allowed for the backoff strategy
2021-01-15 11:44:31 -08:00
type : string
type : object
limit :
2021-12-15 11:15:02 +01:00
description : Limit is the maximum number of attempts for
retrying a failed sync. If set to 0, no retries will
be performed.
2021-01-15 11:44:31 -08:00
format : int64
type : integer
type : object
sync :
2021-04-24 12:50:25 +02:00
description : Sync contains parameters for the operation
2021-01-15 11:44:31 -08:00
properties :
dryRun :
2021-12-15 11:15:02 +01:00
description : DryRun specifies to perform a `kubectl apply
--dry-run` without actually performing the sync
2021-01-15 11:44:31 -08:00
type : boolean
manifests :
2021-12-15 11:15:02 +01:00
description : Manifests is an optional field that overrides
sync source with a local directory for development
2021-01-15 11:44:31 -08:00
items :
type : string
type : array
prune :
2021-12-15 11:15:02 +01:00
description : Prune specifies to delete resources from
the cluster that are no longer tracked in git
2021-01-15 11:44:31 -08:00
type : boolean
resources :
2021-12-15 11:15:02 +01:00
description : Resources describes which resources shall
be part of the sync
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : SyncOperationResource contains resources
to sync.
2019-12-19 09:50:18 +11:00
properties :
2021-01-15 11:44:31 -08:00
group :
type : string
kind :
type : string
name :
type : string
namespace :
type : string
required :
- kind
- name
type : object
type : array
revision :
2021-12-15 11:15:02 +01:00
description : 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.
2021-01-15 11:44:31 -08:00
type : string
source :
2021-12-15 11:15:02 +01:00
description : Source overrides the source definition set
in the application. This is typically set in a Rollback
operation and is nil during a Sync operation
2021-01-15 11:44:31 -08:00
properties :
chart :
2021-12-15 11:15:02 +01:00
description : Chart is a Helm chart name, and must
be specified for applications sourced from a Helm
repo.
2021-01-15 11:44:31 -08:00
type : string
directory :
2021-12-15 11:15:02 +01:00
description : Directory holds path/directory specific
options
2021-01-15 11:44:31 -08:00
properties :
2021-02-13 20:45:16 +01:00
exclude :
2021-12-15 11:15:02 +01:00
description : Exclude contains a glob pattern to
match paths against that should be explicitly
excluded from being used during manifest generation
2021-04-24 12:50:25 +02:00
type : string
include :
2021-12-15 11:15:02 +01:00
description : Include contains a glob pattern to
match paths against that should be explicitly
included during manifest generation
2021-02-13 20:45:16 +01:00
type : string
2021-01-15 11:44:31 -08:00
jsonnet :
2021-12-15 11:15:02 +01:00
description : Jsonnet holds options specific to
Jsonnet
2019-12-19 09:50:18 +11:00
properties :
2021-01-15 11:44:31 -08:00
extVars :
2021-12-15 11:15:02 +01:00
description : ExtVars is a list of Jsonnet
External Variables
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : JsonnetVar represents a variable
to be passed to jsonnet during manifest
generation
2021-01-15 11:44:31 -08:00
properties :
code :
type : boolean
name :
type : string
value :
type : string
required :
- name
- value
type : object
type : array
libs :
description : Additional library search dirs
items :
type : string
type : array
tlas :
2021-12-15 11:15:02 +01:00
description : TLAS is a list of Jsonnet Top-level
Arguments
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : JsonnetVar represents a variable
to be passed to jsonnet during manifest
generation
2021-01-15 11:44:31 -08:00
properties :
code :
type : boolean
name :
type : string
value :
type : string
required :
- name
- value
type : object
type : array
2019-12-19 09:50:18 +11:00
type : object
2021-01-15 11:44:31 -08:00
recurse :
2021-12-15 11:15:02 +01:00
description : Recurse specifies whether to scan
a directory recursively for manifests
2021-01-15 11:44:31 -08:00
type : boolean
type : object
helm :
description : Helm holds helm specific options
2020-04-08 17:43:40 +02:00
properties :
2021-01-15 11:44:31 -08:00
fileParameters :
2021-12-15 11:15:02 +01:00
description : FileParameters are file parameters
to the helm template
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : HelmFileParameter is a file parameter
that's passed to helm template during manifest
generation
2021-01-15 11:44:31 -08:00
properties :
name :
2021-12-15 11:15:02 +01:00
description : Name is the name of the Helm
parameter
2021-01-15 11:44:31 -08:00
type : string
path :
2021-12-15 11:15:02 +01:00
description : Path is the path to the file
containing the values for the Helm parameter
2021-01-15 11:44:31 -08:00
type : string
type : object
type : array
parameters :
2021-12-15 11:15:02 +01:00
description : Parameters is a list of Helm parameters
which are passed to the helm template command
upon manifest generation
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : HelmParameter is a parameter that's
passed to helm template during manifest generation
2021-01-15 11:44:31 -08:00
properties :
forceString :
2021-12-15 11:15:02 +01:00
description : ForceString determines whether
to tell Helm to interpret booleans and
numbers as strings
2021-01-15 11:44:31 -08:00
type : boolean
name :
2021-12-15 11:15:02 +01:00
description : Name is the name of the Helm
parameter
2021-01-15 11:44:31 -08:00
type : string
value :
2021-12-15 11:15:02 +01:00
description : Value is the value for the
Helm parameter
2021-01-15 11:44:31 -08:00
type : string
type : object
type : array
2021-12-15 11:15:02 +01:00
passCredentials :
description : PassCredentials pass credentials
to all domains (Helm's --pass-credentials)
type : boolean
2021-01-15 11:44:31 -08:00
releaseName :
2021-12-15 11:15:02 +01:00
description : ReleaseName is the Helm release name
to use. If omitted it will use the application
name
2020-04-08 17:43:40 +02:00
type : string
2021-01-15 11:44:31 -08:00
valueFiles :
2021-12-15 11:15:02 +01:00
description : ValuesFiles is a list of Helm value
files to use when generating a template
2021-01-15 11:44:31 -08:00
items :
type : string
type : array
values :
2021-12-15 11:15:02 +01:00
description : Values specifies Helm values to be
passed to helm template, typically defined as
a block
2021-01-15 11:44:31 -08:00
type : string
version :
2021-12-15 11:15:02 +01:00
description : Version is the Helm version to use
for templating (either "2" or "3")
2020-04-08 17:43:40 +02:00
type : string
type : object
2021-01-15 11:44:31 -08:00
ksonnet :
description : Ksonnet holds ksonnet specific options
2019-12-19 09:50:18 +11:00
properties :
2021-01-15 11:44:31 -08:00
environment :
2021-12-15 11:15:02 +01:00
description : Environment is a ksonnet application
environment name
2019-12-19 09:50:18 +11:00
type : string
2021-01-15 11:44:31 -08:00
parameters :
2021-12-15 11:15:02 +01:00
description : Parameters are a list of ksonnet
component parameter override values
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : KsonnetParameter is a ksonnet component
parameter
2021-01-15 11:44:31 -08:00
properties :
component :
type : string
name :
type : string
value :
type : string
required :
- name
- value
type : object
type : array
type : object
kustomize :
description : Kustomize holds kustomize specific options
properties :
2021-02-13 20:45:16 +01:00
commonAnnotations :
additionalProperties :
type : string
2021-12-15 11:15:02 +01:00
description : CommonAnnotations is a list of additional
annotations to add to rendered manifests
2021-02-13 20:45:16 +01:00
type : object
2021-01-15 11:44:31 -08:00
commonLabels :
additionalProperties :
type : string
2021-12-15 11:15:02 +01:00
description : CommonLabels is a list of additional
labels to add to rendered manifests
2021-01-15 11:44:31 -08:00
type : object
2021-08-26 10:42:47 -03:00
forceCommonAnnotations :
2021-12-15 11:15:02 +01:00
description : ForceCommonAnnotations specifies
whether to force applying common annotations
to resources for Kustomize apps
2021-08-26 10:42:47 -03:00
type : boolean
forceCommonLabels :
2021-12-15 11:15:02 +01:00
description : ForceCommonLabels specifies whether
to force applying common labels to resources
for Kustomize apps
2021-08-26 10:42:47 -03:00
type : boolean
2021-01-15 11:44:31 -08:00
images :
2021-12-15 11:15:02 +01:00
description : Images is a list of Kustomize image
override specifications
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : KustomizeImage represents a Kustomize
image definition in the format [old_image_name=]<image_name>:<image_tag>
2021-01-15 11:44:31 -08:00
type : string
type : array
namePrefix :
2021-12-15 11:15:02 +01:00
description : NamePrefix is a prefix appended to
resources for Kustomize apps
2021-01-15 11:44:31 -08:00
type : string
nameSuffix :
2021-12-15 11:15:02 +01:00
description : NameSuffix is a suffix appended to
resources for Kustomize apps
2021-01-15 11:44:31 -08:00
type : string
version :
2021-12-15 11:15:02 +01:00
description : Version controls which version of
Kustomize to use for rendering manifests
2019-12-19 09:50:18 +11:00
type : string
type : object
2021-01-15 11:44:31 -08:00
path :
2021-12-15 11:15:02 +01:00
description : Path is a directory path within the Git
repository, and is only valid for applications sourced
from Git.
2019-12-19 09:50:18 +11:00
type : string
2021-01-15 11:44:31 -08:00
plugin :
2021-12-15 11:15:02 +01:00
description : ConfigManagementPlugin holds config management
plugin specific options
2019-12-19 09:50:18 +11:00
properties :
2021-01-15 11:44:31 -08:00
env :
2021-12-15 11:15:02 +01:00
description : Env is a list of environment variable
entries
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : EnvEntry represents an entry in
the application's environment
2021-01-15 11:44:31 -08:00
properties :
name :
2021-12-15 11:15:02 +01:00
description : Name is the name of the variable,
usually expressed in uppercase
2021-01-15 11:44:31 -08:00
type : string
value :
2021-04-24 12:50:25 +02:00
description : Value is the value of the variable
2021-01-15 11:44:31 -08:00
type : string
required :
- name
- value
type : object
type : array
2019-12-19 09:50:18 +11:00
name :
type : string
type : object
2021-01-15 11:44:31 -08:00
repoURL :
2021-12-15 11:15:02 +01:00
description : RepoURL is the URL to the repository
(Git or Helm) that contains the application manifests
2019-12-19 09:50:18 +11:00
type : string
2021-01-15 11:44:31 -08:00
targetRevision :
2021-12-15 11:15:02 +01:00
description : 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.
2019-12-19 09:50:18 +11:00
type : string
2021-01-15 11:44:31 -08:00
required :
- repoURL
type : object
syncOptions :
2021-12-15 11:15:02 +01:00
description : SyncOptions provide per-sync sync-options,
e.g. Validate=false
2021-01-15 11:44:31 -08:00
items :
2020-04-08 17:43:40 +02:00
type : string
2021-01-15 11:44:31 -08:00
type : array
syncStrategy :
2021-12-15 11:15:02 +01:00
description : SyncStrategy describes how to perform the
sync
2021-01-15 11:44:31 -08:00
properties :
apply :
2021-12-15 11:15:02 +01:00
description : Apply will perform a `kubectl apply`
to perform the sync.
2021-01-15 11:44:31 -08:00
properties :
force :
2021-12-15 11:15:02 +01:00
description : 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.
2021-01-15 11:44:31 -08:00
type : boolean
type : object
hook :
2021-12-15 11:15:02 +01:00
description : Hook will submit any referenced resources
to perform the sync. This is the default strategy
2021-01-15 11:44:31 -08:00
properties :
force :
2021-12-15 11:15:02 +01:00
description : 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.
2021-01-15 11:44:31 -08:00
type : boolean
type : object
type : object
type : object
type : object
phase :
description : Phase is the current phase of the operation
type : string
retryCount :
description : RetryCount contains time of operation retries
format : int64
type : integer
startedAt :
description : StartedAt contains time of operation start
format : date-time
type : string
syncResult :
description : SyncResult is the result of a Sync operation
properties :
resources :
2021-12-15 11:15:02 +01:00
description : Resources contains a list of sync result items
for each individual resource in a sync operation
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : ResourceResult holds the operation result details
of a specific resource
2021-01-15 11:44:31 -08:00
properties :
group :
2021-04-24 12:50:25 +02:00
description : Group specifies the API group of the resource
2021-01-15 11:44:31 -08:00
type : string
hookPhase :
2021-12-15 11:15:02 +01:00
description : HookPhase contains the state of any operation
associated with this resource OR hook This can also
contain values for non-hook resources.
2021-01-15 11:44:31 -08:00
type : string
hookType :
2021-12-15 11:15:02 +01:00
description : HookType specifies the type of the hook.
Empty for non-hook resources
2021-01-15 11:44:31 -08:00
type : string
kind :
2021-04-24 12:50:25 +02:00
description : Kind specifies the API kind of the resource
2021-01-15 11:44:31 -08:00
type : string
message :
2021-12-15 11:15:02 +01:00
description : Message contains an informational or error
message for the last sync OR operation
2021-01-15 11:44:31 -08:00
type : string
name :
2021-04-24 12:50:25 +02:00
description : Name specifies the name of the resource
2021-01-15 11:44:31 -08:00
type : string
namespace :
2021-12-15 11:15:02 +01:00
description : Namespace specifies the target namespace
of the resource
2021-01-15 11:44:31 -08:00
type : string
status :
2021-12-15 11:15:02 +01:00
description : Status holds the final result of the sync.
Will be empty if the resources is yet to be applied/pruned
and is always zero-value for hooks
2021-01-15 11:44:31 -08:00
type : string
syncPhase :
2021-12-15 11:15:02 +01:00
description : SyncPhase indicates the particular phase
of the sync that this result was acquired in
2019-12-19 09:50:18 +11:00
type : string
2020-05-14 04:16:36 +02:00
version :
2021-12-15 11:15:02 +01:00
description : Version specifies the API version of the
resource
2020-05-14 04:16:36 +02:00
type : string
2021-01-15 11:44:31 -08:00
required :
- group
- kind
- name
- namespace
- version
2019-12-19 09:50:18 +11:00
type : object
2021-01-15 11:44:31 -08:00
type : array
revision :
2021-12-15 11:15:02 +01:00
description : Revision holds the revision this sync operation
was performed to
2021-01-15 11:44:31 -08:00
type : string
source :
2021-12-15 11:15:02 +01:00
description : Source records the application source information
of the sync, used for comparing auto-sync
2021-01-15 11:44:31 -08:00
properties :
chart :
2021-12-15 11:15:02 +01:00
description : Chart is a Helm chart name, and must be specified
for applications sourced from a Helm repo.
2021-01-15 11:44:31 -08:00
type : string
directory :
description : Directory holds path/directory specific options
properties :
2021-02-13 20:45:16 +01:00
exclude :
2021-12-15 11:15:02 +01:00
description : Exclude contains a glob pattern to match
paths against that should be explicitly excluded
from being used during manifest generation
2021-04-24 12:50:25 +02:00
type : string
include :
2021-12-15 11:15:02 +01:00
description : Include contains a glob pattern to match
paths against that should be explicitly included
during manifest generation
2021-02-13 20:45:16 +01:00
type : string
2021-01-15 11:44:31 -08:00
jsonnet :
2021-04-24 12:50:25 +02:00
description : Jsonnet holds options specific to Jsonnet
2019-12-19 09:50:18 +11:00
properties :
2021-01-15 11:44:31 -08:00
extVars :
2021-12-15 11:15:02 +01:00
description : ExtVars is a list of Jsonnet External
Variables
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : JsonnetVar represents a variable
to be passed to jsonnet during manifest generation
2021-01-15 11:44:31 -08:00
properties :
code :
type : boolean
name :
type : string
value :
type : string
required :
- name
- value
type : object
type : array
libs :
description : Additional library search dirs
items :
type : string
type : array
tlas :
2021-12-15 11:15:02 +01:00
description : TLAS is a list of Jsonnet Top-level
Arguments
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : JsonnetVar represents a variable
to be passed to jsonnet during manifest generation
2021-01-15 11:44:31 -08:00
properties :
code :
type : boolean
name :
type : string
value :
type : string
required :
- name
- value
type : object
type : array
2019-12-19 09:50:18 +11:00
type : object
2021-01-15 11:44:31 -08:00
recurse :
2021-12-15 11:15:02 +01:00
description : Recurse specifies whether to scan a directory
recursively for manifests
2021-01-15 11:44:31 -08:00
type : boolean
type : object
helm :
description : Helm holds helm specific options
properties :
fileParameters :
2021-12-15 11:15:02 +01:00
description : FileParameters are file parameters to
the helm template
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : HelmFileParameter is a file parameter
that's passed to helm template during manifest
generation
2021-01-15 11:44:31 -08:00
properties :
name :
2021-04-24 12:50:25 +02:00
description : Name is the name of the Helm parameter
2021-01-15 11:44:31 -08:00
type : string
path :
2021-12-15 11:15:02 +01:00
description : Path is the path to the file containing
the values for the Helm parameter
2021-01-15 11:44:31 -08:00
type : string
type : object
type : array
parameters :
2021-12-15 11:15:02 +01:00
description : Parameters is a list of Helm parameters
which are passed to the helm template command upon
manifest generation
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : HelmParameter is a parameter that's
passed to helm template during manifest generation
2021-01-15 11:44:31 -08:00
properties :
forceString :
2021-12-15 11:15:02 +01:00
description : ForceString determines whether
to tell Helm to interpret booleans and numbers
as strings
2021-01-15 11:44:31 -08:00
type : boolean
name :
2021-04-24 12:50:25 +02:00
description : Name is the name of the Helm parameter
2021-01-15 11:44:31 -08:00
type : string
value :
2021-12-15 11:15:02 +01:00
description : Value is the value for the Helm
parameter
2021-01-15 11:44:31 -08:00
type : string
type : object
type : array
2021-12-15 11:15:02 +01:00
passCredentials :
description : PassCredentials pass credentials to all
domains (Helm's --pass-credentials)
type : boolean
2021-01-15 11:44:31 -08:00
releaseName :
2021-12-15 11:15:02 +01:00
description : ReleaseName is the Helm release name
to use. If omitted it will use the application name
2021-01-15 11:44:31 -08:00
type : string
valueFiles :
2021-12-15 11:15:02 +01:00
description : ValuesFiles is a list of Helm value files
to use when generating a template
2021-01-15 11:44:31 -08:00
items :
type : string
type : array
values :
2021-12-15 11:15:02 +01:00
description : Values specifies Helm values to be passed
to helm template, typically defined as a block
2021-01-15 11:44:31 -08:00
type : string
version :
2021-12-15 11:15:02 +01:00
description : Version is the Helm version to use for
templating (either "2" or "3")
2021-01-15 11:44:31 -08:00
type : string
type : object
ksonnet :
description : Ksonnet holds ksonnet specific options
properties :
environment :
2021-12-15 11:15:02 +01:00
description : Environment is a ksonnet application
environment name
2021-01-15 11:44:31 -08:00
type : string
parameters :
2021-12-15 11:15:02 +01:00
description : Parameters are a list of ksonnet component
parameter override values
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : KsonnetParameter is a ksonnet component
parameter
2021-01-15 11:44:31 -08:00
properties :
component :
type : string
name :
type : string
value :
type : string
required :
- name
- value
type : object
type : array
type : object
kustomize :
description : Kustomize holds kustomize specific options
properties :
2021-02-13 20:45:16 +01:00
commonAnnotations :
additionalProperties :
type : string
2021-12-15 11:15:02 +01:00
description : CommonAnnotations is a list of additional
annotations to add to rendered manifests
2021-02-13 20:45:16 +01:00
type : object
2021-01-15 11:44:31 -08:00
commonLabels :
additionalProperties :
type : string
2021-12-15 11:15:02 +01:00
description : CommonLabels is a list of additional
labels to add to rendered manifests
2021-01-15 11:44:31 -08:00
type : object
2021-08-26 10:42:47 -03:00
forceCommonAnnotations :
2021-12-15 11:15:02 +01:00
description : ForceCommonAnnotations specifies whether
to force applying common annotations to resources
for Kustomize apps
2021-08-26 10:42:47 -03:00
type : boolean
forceCommonLabels :
2021-12-15 11:15:02 +01:00
description : ForceCommonLabels specifies whether to
force applying common labels to resources for Kustomize
apps
2021-08-26 10:42:47 -03:00
type : boolean
2021-01-15 11:44:31 -08:00
images :
2021-12-15 11:15:02 +01:00
description : Images is a list of Kustomize image override
specifications
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : KustomizeImage represents a Kustomize
image definition in the format [old_image_name=]<image_name>:<image_tag>
2021-01-15 11:44:31 -08:00
type : string
type : array
namePrefix :
2021-12-15 11:15:02 +01:00
description : NamePrefix is a prefix appended to resources
for Kustomize apps
2021-01-15 11:44:31 -08:00
type : string
nameSuffix :
2021-12-15 11:15:02 +01:00
description : NameSuffix is a suffix appended to resources
for Kustomize apps
2021-01-15 11:44:31 -08:00
type : string
version :
2021-12-15 11:15:02 +01:00
description : Version controls which version of Kustomize
to use for rendering manifests
2021-01-15 11:44:31 -08:00
type : string
type : object
path :
2021-12-15 11:15:02 +01:00
description : Path is a directory path within the Git repository,
and is only valid for applications sourced from Git.
2021-01-15 11:44:31 -08:00
type : string
plugin :
2021-12-15 11:15:02 +01:00
description : ConfigManagementPlugin holds config management
plugin specific options
2021-01-15 11:44:31 -08:00
properties :
env :
2021-12-15 11:15:02 +01:00
description : Env is a list of environment variable
entries
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : EnvEntry represents an entry in the
application's environment
2021-01-15 11:44:31 -08:00
properties :
name :
2021-12-15 11:15:02 +01:00
description : Name is the name of the variable,
usually expressed in uppercase
2021-01-15 11:44:31 -08:00
type : string
value :
2021-04-24 12:50:25 +02:00
description : Value is the value of the variable
2021-01-15 11:44:31 -08:00
type : string
required :
- name
- value
type : object
type : array
name :
type : string
type : object
repoURL :
2021-12-15 11:15:02 +01:00
description : RepoURL is the URL to the repository (Git
or Helm) that contains the application manifests
2021-01-15 11:44:31 -08:00
type : string
targetRevision :
2021-12-15 11:15:02 +01:00
description : 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.
2021-01-15 11:44:31 -08:00
type : string
required :
- repoURL
type : object
required :
- revision
type : object
required :
- operation
- phase
- startedAt
type : object
reconciledAt :
2021-12-15 11:15:02 +01:00
description : ReconciledAt indicates when the application state was
reconciled using the latest git version
2021-01-15 11:44:31 -08:00
format : date-time
type : string
resources :
2021-12-15 11:15:02 +01:00
description : Resources is a list of Kubernetes resources managed by
this application
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : 'ResourceStatus holds the current sync and health status
of a resource TODO : describe members of this type'
2021-01-15 11:44:31 -08:00
properties :
group :
type : string
health :
2021-12-15 11:15:02 +01:00
description : HealthStatus contains information about the currently
observed health state of an application or resource
2021-01-15 11:44:31 -08:00
properties :
message :
2021-12-15 11:15:02 +01:00
description : Message is a human-readable informational message
describing the health status
2019-12-19 09:50:18 +11:00
type : string
2021-01-15 11:44:31 -08:00
status :
2021-12-15 11:15:02 +01:00
description : Status holds the status code of the application
or resource
2019-12-19 09:50:18 +11:00
type : string
type : object
2021-01-15 11:44:31 -08:00
hook :
type : boolean
kind :
type : string
name :
type : string
namespace :
type : string
requiresPruning :
type : boolean
status :
2021-12-15 11:15:02 +01:00
description : SyncStatusCode is a type which represents possible
comparison results
2021-01-15 11:44:31 -08:00
type : string
version :
type : string
2019-12-19 09:50:18 +11:00
type : object
2021-01-15 11:44:31 -08:00
type : array
sourceType :
2021-04-24 12:50:25 +02:00
description : SourceType specifies the type of this application
2021-01-15 11:44:31 -08:00
type : string
summary :
2021-12-15 11:15:02 +01:00
description : Summary contains a list of URLs and container images
used by this application
2021-01-15 11:44:31 -08:00
properties :
externalURLs :
2021-12-15 11:15:02 +01:00
description : ExternalURLs holds all external URLs of application
child resources.
2021-01-15 11:44:31 -08:00
items :
type : string
type : array
images :
description : Images holds all images of application child resources.
items :
type : string
type : array
type : object
sync :
2021-12-15 11:15:02 +01:00
description : Sync contains information about the application's current
sync status
2021-01-15 11:44:31 -08:00
properties :
comparedTo :
2021-12-15 11:15:02 +01:00
description : ComparedTo contains information about what has been
compared
2021-01-15 11:44:31 -08:00
properties :
destination :
2021-12-15 11:15:02 +01:00
description : Destination is a reference to the application's
destination used for comparison
2021-01-15 11:44:31 -08:00
properties :
name :
2021-12-15 11:15:02 +01:00
description : Name is an alternate way of specifying the
target cluster by its symbolic name
2021-01-15 11:44:31 -08:00
type : string
namespace :
2021-12-15 11:15:02 +01:00
description : 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
2021-01-15 11:44:31 -08:00
type : string
server :
2021-12-15 11:15:02 +01:00
description : Server specifies the URL of the target cluster
and must be set to the Kubernetes control plane API
2021-01-15 11:44:31 -08:00
type : string
type : object
source :
2021-12-15 11:15:02 +01:00
description : Source is a reference to the application's source
used for comparison
2021-01-15 11:44:31 -08:00
properties :
chart :
2021-12-15 11:15:02 +01:00
description : Chart is a Helm chart name, and must be specified
for applications sourced from a Helm repo.
2021-01-15 11:44:31 -08:00
type : string
directory :
description : Directory holds path/directory specific options
properties :
2021-02-13 20:45:16 +01:00
exclude :
2021-12-15 11:15:02 +01:00
description : Exclude contains a glob pattern to match
paths against that should be explicitly excluded
from being used during manifest generation
2021-04-24 12:50:25 +02:00
type : string
include :
2021-12-15 11:15:02 +01:00
description : Include contains a glob pattern to match
paths against that should be explicitly included
during manifest generation
2021-02-13 20:45:16 +01:00
type : string
2021-01-15 11:44:31 -08:00
jsonnet :
2021-04-24 12:50:25 +02:00
description : Jsonnet holds options specific to Jsonnet
2021-01-15 11:44:31 -08:00
properties :
extVars :
2021-12-15 11:15:02 +01:00
description : ExtVars is a list of Jsonnet External
Variables
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : JsonnetVar represents a variable
to be passed to jsonnet during manifest generation
2021-01-15 11:44:31 -08:00
properties :
code :
type : boolean
name :
type : string
value :
type : string
required :
- name
- value
type : object
type : array
libs :
description : Additional library search dirs
items :
type : string
type : array
tlas :
2021-12-15 11:15:02 +01:00
description : TLAS is a list of Jsonnet Top-level
Arguments
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : JsonnetVar represents a variable
to be passed to jsonnet during manifest generation
2021-01-15 11:44:31 -08:00
properties :
code :
type : boolean
name :
type : string
value :
type : string
required :
- name
- value
type : object
type : array
type : object
recurse :
2021-12-15 11:15:02 +01:00
description : Recurse specifies whether to scan a directory
recursively for manifests
2021-01-15 11:44:31 -08:00
type : boolean
type : object
helm :
description : Helm holds helm specific options
properties :
fileParameters :
2021-12-15 11:15:02 +01:00
description : FileParameters are file parameters to
the helm template
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : HelmFileParameter is a file parameter
that's passed to helm template during manifest
generation
2021-01-15 11:44:31 -08:00
properties :
name :
2021-04-24 12:50:25 +02:00
description : Name is the name of the Helm parameter
2021-01-15 11:44:31 -08:00
type : string
path :
2021-12-15 11:15:02 +01:00
description : Path is the path to the file containing
the values for the Helm parameter
2021-01-15 11:44:31 -08:00
type : string
type : object
type : array
parameters :
2021-12-15 11:15:02 +01:00
description : Parameters is a list of Helm parameters
which are passed to the helm template command upon
manifest generation
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : HelmParameter is a parameter that's
passed to helm template during manifest generation
2021-01-15 11:44:31 -08:00
properties :
forceString :
2021-12-15 11:15:02 +01:00
description : ForceString determines whether
to tell Helm to interpret booleans and numbers
as strings
2021-01-15 11:44:31 -08:00
type : boolean
name :
2021-04-24 12:50:25 +02:00
description : Name is the name of the Helm parameter
2021-01-15 11:44:31 -08:00
type : string
value :
2021-12-15 11:15:02 +01:00
description : Value is the value for the Helm
parameter
2021-01-15 11:44:31 -08:00
type : string
type : object
type : array
2021-12-15 11:15:02 +01:00
passCredentials :
description : PassCredentials pass credentials to all
domains (Helm's --pass-credentials)
type : boolean
2021-01-15 11:44:31 -08:00
releaseName :
2021-12-15 11:15:02 +01:00
description : ReleaseName is the Helm release name
to use. If omitted it will use the application name
2021-01-15 11:44:31 -08:00
type : string
valueFiles :
2021-12-15 11:15:02 +01:00
description : ValuesFiles is a list of Helm value files
to use when generating a template
2021-01-15 11:44:31 -08:00
items :
type : string
type : array
values :
2021-12-15 11:15:02 +01:00
description : Values specifies Helm values to be passed
to helm template, typically defined as a block
2021-01-15 11:44:31 -08:00
type : string
version :
2021-12-15 11:15:02 +01:00
description : Version is the Helm version to use for
templating (either "2" or "3")
2021-01-15 11:44:31 -08:00
type : string
type : object
ksonnet :
description : Ksonnet holds ksonnet specific options
properties :
environment :
2021-12-15 11:15:02 +01:00
description : Environment is a ksonnet application
environment name
2021-01-15 11:44:31 -08:00
type : string
parameters :
2021-12-15 11:15:02 +01:00
description : Parameters are a list of ksonnet component
parameter override values
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : KsonnetParameter is a ksonnet component
parameter
2021-01-15 11:44:31 -08:00
properties :
component :
type : string
name :
type : string
value :
type : string
required :
- name
- value
type : object
type : array
type : object
kustomize :
description : Kustomize holds kustomize specific options
properties :
2021-02-13 20:45:16 +01:00
commonAnnotations :
additionalProperties :
type : string
2021-12-15 11:15:02 +01:00
description : CommonAnnotations is a list of additional
annotations to add to rendered manifests
2021-02-13 20:45:16 +01:00
type : object
2021-01-15 11:44:31 -08:00
commonLabels :
additionalProperties :
type : string
2021-12-15 11:15:02 +01:00
description : CommonLabels is a list of additional
labels to add to rendered manifests
2021-01-15 11:44:31 -08:00
type : object
2021-08-26 10:42:47 -03:00
forceCommonAnnotations :
2021-12-15 11:15:02 +01:00
description : ForceCommonAnnotations specifies whether
to force applying common annotations to resources
for Kustomize apps
2021-08-26 10:42:47 -03:00
type : boolean
forceCommonLabels :
2021-12-15 11:15:02 +01:00
description : ForceCommonLabels specifies whether to
force applying common labels to resources for Kustomize
apps
2021-08-26 10:42:47 -03:00
type : boolean
2021-01-15 11:44:31 -08:00
images :
2021-12-15 11:15:02 +01:00
description : Images is a list of Kustomize image override
specifications
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : KustomizeImage represents a Kustomize
image definition in the format [old_image_name=]<image_name>:<image_tag>
2021-01-15 11:44:31 -08:00
type : string
type : array
namePrefix :
2021-12-15 11:15:02 +01:00
description : NamePrefix is a prefix appended to resources
for Kustomize apps
2021-01-15 11:44:31 -08:00
type : string
nameSuffix :
2021-12-15 11:15:02 +01:00
description : NameSuffix is a suffix appended to resources
for Kustomize apps
2021-01-15 11:44:31 -08:00
type : string
version :
2021-12-15 11:15:02 +01:00
description : Version controls which version of Kustomize
to use for rendering manifests
2021-01-15 11:44:31 -08:00
type : string
type : object
path :
2021-12-15 11:15:02 +01:00
description : Path is a directory path within the Git repository,
and is only valid for applications sourced from Git.
2021-01-15 11:44:31 -08:00
type : string
plugin :
2021-12-15 11:15:02 +01:00
description : ConfigManagementPlugin holds config management
plugin specific options
2021-01-15 11:44:31 -08:00
properties :
env :
2021-12-15 11:15:02 +01:00
description : Env is a list of environment variable
entries
2021-01-15 11:44:31 -08:00
items :
2021-12-15 11:15:02 +01:00
description : EnvEntry represents an entry in the
application's environment
2021-01-15 11:44:31 -08:00
properties :
name :
2021-12-15 11:15:02 +01:00
description : Name is the name of the variable,
usually expressed in uppercase
2021-01-15 11:44:31 -08:00
type : string
value :
2021-04-24 12:50:25 +02:00
description : Value is the value of the variable
2021-01-15 11:44:31 -08:00
type : string
required :
- name
- value
type : object
type : array
name :
type : string
type : object
repoURL :
2021-12-15 11:15:02 +01:00
description : RepoURL is the URL to the repository (Git
or Helm) that contains the application manifests
2021-01-15 11:44:31 -08:00
type : string
targetRevision :
2021-12-15 11:15:02 +01:00
description : 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.
2021-01-15 11:44:31 -08:00
type : string
required :
- repoURL
type : object
required :
- destination
- source
type : object
revision :
2021-12-15 11:15:02 +01:00
description : Revision contains information about the revision
the comparison has been performed to
2021-01-15 11:44:31 -08:00
type : string
status :
2021-04-24 12:50:25 +02:00
description : Status is the sync state of the comparison
2021-01-15 11:44:31 -08:00
type : string
required :
- status
type : object
type : object
required :
- metadata
- spec
type : object
2021-04-24 12:50:25 +02:00
served : true
storage : true
subresources : {}