2019-12-19 09:50:18 +11:00
apiVersion : apiextensions.k8s.io/v1beta1
kind : CustomResourceDefinition
metadata :
labels :
app.kubernetes.io/name : applications.argoproj.io
app.kubernetes.io/part-of : argocd
name : applications.argoproj.io
2020-04-08 17:43:40 +02:00
annotations :
helm.sh/hook : crd-install
2019-12-19 09:50:18 +11:00
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
validation :
openAPIV3Schema :
description : Application is a definition of Application resource.
properties :
apiVersion :
2020-04-08 17:43:40 +02:00
description : 'APIVersion defines the versioned schema of this representation
2019-12-19 09:50:18 +11:00
of an object. Servers should convert recognized schemas to the latest
2020-04-08 17:43:40 +02:00
internal value, and may reject unrecognized values. More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
2019-12-19 09:50:18 +11:00
type : string
kind :
2020-04-08 17:43:40 +02:00
description : 'Kind is a string value representing the REST resource this
2019-12-19 09:50:18 +11:00
object represents. Servers may infer this from the endpoint the client
2020-04-08 17:43:40 +02:00
submits requests to. Cannot be updated. In CamelCase. More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
2019-12-19 09:50:18 +11:00
type : string
metadata :
type : object
operation :
2020-04-08 17:43:40 +02:00
description : Operation contains requested operation parameters.
2019-12-19 09:50:18 +11:00
properties :
2020-04-08 17:43:40 +02:00
initiatedBy :
description : OperationInitiator holds information about the operation
initiator
properties :
automated :
description : Automated is set to true if operation was initiated
automatically by the application controller.
type : boolean
username :
description : Name of a user who started operation.
type : string
type : object
2019-12-19 09:50:18 +11:00
sync :
2020-04-08 17:43:40 +02:00
description : SyncOperation contains sync operation details.
2019-12-19 09:50:18 +11:00
properties :
dryRun :
2020-04-08 17:43:40 +02:00
description : DryRun will perform a `kubectl apply --dry-run` without
2019-12-19 09:50:18 +11:00
actually performing the sync
type : boolean
manifests :
2020-04-08 17:43:40 +02:00
description : Manifests is an optional field that overrides sync
2019-12-19 09:50:18 +11:00
source with a local directory for development
items :
type : string
type : array
prune :
2020-04-08 17:43:40 +02:00
description : Prune deletes resources that are no longer tracked
2019-12-19 09:50:18 +11:00
in git
type : boolean
resources :
description : Resources describes which resources to sync
items :
2020-04-08 17:43:40 +02:00
description : SyncOperationResource contains resources to sync.
2019-12-19 09:50:18 +11:00
properties :
group :
type : string
kind :
type : string
name :
type : string
required :
2020-04-08 17:43:40 +02:00
- kind
- name
2019-12-19 09:50:18 +11:00
type : object
type : array
revision :
2020-04-08 17:43:40 +02:00
description : Revision is the revision in which to sync the application
2019-12-19 09:50:18 +11:00
to. If omitted, will use the revision specified in app spec.
type : string
source :
2020-04-08 17:43:40 +02:00
description : Source overrides the source definition set in the application.
2019-12-19 09:50:18 +11:00
This is typically set in a Rollback operation and nil during a
Sync operation
properties :
chart :
description : Chart is a Helm chart name
type : string
directory :
description : Directory holds path/directory specific options
properties :
jsonnet :
2020-04-08 17:43:40 +02:00
description : ApplicationSourceJsonnet holds jsonnet specific
options
2019-12-19 09:50:18 +11:00
properties :
extVars :
description : ExtVars is a list of Jsonnet External Variables
items :
2020-04-08 17:43:40 +02:00
description : JsonnetVar is a jsonnet variable
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
tlas :
description : TLAS is a list of Jsonnet Top-level Arguments
items :
2020-04-08 17:43:40 +02:00
description : JsonnetVar is a jsonnet variable
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 :
type : boolean
type : object
helm :
description : Helm holds helm specific options
properties :
2020-04-08 17:43:40 +02:00
fileParameters :
description : FileParameters are file parameters to the helm
template
items :
description : HelmFileParameter is a file parameter to
a helm template
properties :
name :
description : Name is the name of the helm parameter
type : string
path :
description : Path is the path value for the helm parameter
type : string
type : object
type : array
2019-12-19 09:50:18 +11:00
parameters :
description : Parameters are parameters to the helm template
items :
2020-04-08 17:43:40 +02:00
description : HelmParameter is a parameter to a helm template
2019-12-19 09:50:18 +11:00
properties :
forceString :
2020-04-08 17:43:40 +02:00
description : ForceString determines whether to tell
2019-12-19 09:50:18 +11:00
Helm to interpret booleans and numbers as strings
type : boolean
name :
description : Name is the name of the helm parameter
type : string
value :
description : Value is the value for the helm parameter
type : string
type : object
type : array
releaseName :
2020-04-08 17:43:40 +02:00
description : The Helm release name. If omitted it will use
2019-12-19 09:50:18 +11:00
the application name
type : string
valueFiles :
2020-04-08 17:43:40 +02:00
description : ValuesFiles is a list of Helm value files to
2019-12-19 09:50:18 +11:00
use when generating a template
items :
type : string
type : array
values :
2020-04-08 17:43:40 +02:00
description : Values is Helm values, typically defined as
2019-12-19 09:50:18 +11:00
a block
type : string
type : object
ksonnet :
description : Ksonnet holds ksonnet specific options
properties :
environment :
2020-04-08 17:43:40 +02:00
description : Environment is a ksonnet application environment
2019-12-19 09:50:18 +11:00
name
type : string
parameters :
2020-04-08 17:43:40 +02:00
description : Parameters are a list of ksonnet component
2019-12-19 09:50:18 +11:00
parameter override values
items :
2020-04-08 17:43:40 +02: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 :
commonLabels :
additionalProperties :
type : string
description : CommonLabels adds additional kustomize commonLabels
type : object
images :
description : Images are kustomize image overrides
items :
type : string
type : array
namePrefix :
2020-04-08 17:43:40 +02:00
description : NamePrefix is a prefix appended to resources
for kustomize apps
type : string
nameSuffix :
description : NameSuffix is a suffix appended to resources
2019-12-19 09:50:18 +11:00
for kustomize apps
type : string
type : object
path :
description : Path is a directory path within the Git repository
type : string
plugin :
2020-04-08 17:43:40 +02:00
description : ConfigManagementPlugin holds config management
2019-12-19 09:50:18 +11:00
plugin specific options
properties :
env :
items :
properties :
name :
description : the name, usually uppercase
type : string
value :
description : the 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
name :
type : string
type : object
repoURL :
2020-04-08 17:43:40 +02:00
description : RepoURL is the repository URL of the application
2019-12-19 09:50:18 +11:00
manifests
type : string
targetRevision :
2020-04-08 17:43:40 +02:00
description : TargetRevision defines the commit, tag, or branch
2019-12-19 09:50:18 +11:00
in which to sync the application to. If omitted, will sync
to HEAD
type : string
required :
2020-04-08 17:43:40 +02:00
- repoURL
2019-12-19 09:50:18 +11:00
type : object
2020-04-08 17:43:40 +02:00
syncOptions :
description : SyncOptions provide per-sync sync-options, e.g. Validate=false
items :
type : string
type : array
2019-12-19 09:50:18 +11:00
syncStrategy :
description : SyncStrategy describes how to perform the sync
properties :
apply :
2020-04-08 17:43:40 +02:00
description : Apply wil perform a `kubectl apply` to perform
2019-12-19 09:50:18 +11:00
the sync.
properties :
force :
2020-04-08 17:43:40 +02:00
description : Force indicates whether or not to supply the
2019-12-19 09:50:18 +11:00
--force flag to `kubectl apply`. The --force flag deletes
and re-create the resource, when PATCH encounters conflict
and has retried for 5 times.
type : boolean
type : object
hook :
2020-04-08 17:43:40 +02:00
description : Hook will submit any referenced resources to perform
2019-12-19 09:50:18 +11:00
the sync. This is the default strategy
properties :
force :
2020-04-08 17:43:40 +02:00
description : Force indicates whether or not to supply the
2019-12-19 09:50:18 +11:00
--force flag to `kubectl apply`. The --force flag deletes
and re-create the resource, when PATCH encounters conflict
and has retried for 5 times.
type : boolean
type : object
type : object
type : object
type : object
spec :
2020-04-08 17:43:40 +02:00
description : ApplicationSpec represents desired application state. Contains
link to repository with application definition and additional parameters
link definition revision.
2019-12-19 09:50:18 +11:00
properties :
destination :
2020-04-08 17:43:40 +02:00
description : Destination overrides the kubernetes server and namespace
2019-12-19 09:50:18 +11:00
defined in the environment ksonnet app.yaml
properties :
namespace :
2020-04-08 17:43:40 +02:00
description : Namespace overrides the environment namespace value
2019-12-19 09:50:18 +11:00
in the ksonnet app.yaml
type : string
server :
2020-04-08 17:43:40 +02:00
description : Server overrides the environment server value in the
2019-12-19 09:50:18 +11:00
ksonnet app.yaml
type : string
type : object
ignoreDifferences :
2020-04-08 17:43:40 +02:00
description : IgnoreDifferences controls resources fields which should
2019-12-19 09:50:18 +11:00
be ignored during comparison
items :
2020-04-08 17:43:40 +02:00
description : ResourceIgnoreDifferences contains resource filter and
list of json paths which should be ignored during comparison with
live state.
2019-12-19 09:50:18 +11:00
properties :
group :
type : string
jsonPointers :
items :
type : string
type : array
kind :
type : string
name :
type : string
namespace :
type : string
required :
2020-04-08 17:43:40 +02:00
- jsonPointers
- kind
2019-12-19 09:50:18 +11:00
type : object
type : array
info :
2020-04-08 17:43:40 +02:00
description : Infos contains a list of useful information (URLs, email
2019-12-19 09:50:18 +11:00
addresses, and plain text) that relates to the application
items :
properties :
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
project :
2020-04-08 17:43:40 +02:00
description : Project is a application project name. Empty name means
2019-12-19 09:50:18 +11:00
that application belongs to 'default' project.
type : string
2020-04-08 17:43:40 +02:00
revisionHistoryLimit :
description : This limits this number of items kept in the apps revision
history. 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.
format : int64
type : integer
2019-12-19 09:50:18 +11:00
source :
2020-04-08 17:43:40 +02:00
description : Source is a reference to the location ksonnet application
2019-12-19 09:50:18 +11:00
definition
properties :
chart :
description : Chart is a Helm chart name
type : string
directory :
description : Directory holds path/directory specific options
properties :
jsonnet :
2020-04-08 17:43:40 +02:00
description : ApplicationSourceJsonnet holds jsonnet specific
options
2019-12-19 09:50:18 +11:00
properties :
extVars :
description : ExtVars is a list of Jsonnet External Variables
items :
2020-04-08 17:43:40 +02:00
description : JsonnetVar is a jsonnet variable
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
tlas :
description : TLAS is a list of Jsonnet Top-level Arguments
items :
2020-04-08 17:43:40 +02:00
description : JsonnetVar is a jsonnet variable
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 :
type : boolean
type : object
helm :
description : Helm holds helm specific options
properties :
2020-04-08 17:43:40 +02:00
fileParameters :
description : FileParameters are file parameters to the helm
template
items :
description : HelmFileParameter is a file parameter to a helm
template
properties :
name :
description : Name is the name of the helm parameter
type : string
path :
description : Path is the path value for the helm parameter
type : string
type : object
type : array
2019-12-19 09:50:18 +11:00
parameters :
description : Parameters are parameters to the helm template
items :
2020-04-08 17:43:40 +02:00
description : HelmParameter is a parameter to a helm template
2019-12-19 09:50:18 +11:00
properties :
forceString :
2020-04-08 17:43:40 +02:00
description : ForceString determines whether to tell Helm
2019-12-19 09:50:18 +11:00
to interpret booleans and numbers as strings
type : boolean
name :
description : Name is the name of the helm parameter
type : string
value :
description : Value is the value for the helm parameter
type : string
type : object
type : array
releaseName :
2020-04-08 17:43:40 +02:00
description : The Helm release name. If omitted it will use the
2019-12-19 09:50:18 +11:00
application name
type : string
valueFiles :
2020-04-08 17:43:40 +02:00
description : ValuesFiles is a list of Helm value files to use
2019-12-19 09:50:18 +11:00
when generating a template
items :
type : string
type : array
values :
description : Values is Helm values, typically defined as a block
type : string
type : object
ksonnet :
description : Ksonnet holds ksonnet specific options
properties :
environment :
2020-04-08 17:43:40 +02:00
description : Environment is a ksonnet application environment
2019-12-19 09:50:18 +11:00
name
type : string
parameters :
2020-04-08 17:43:40 +02:00
description : Parameters are a list of ksonnet component parameter
2019-12-19 09:50:18 +11:00
override values
items :
2020-04-08 17:43:40 +02: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 :
commonLabels :
additionalProperties :
type : string
description : CommonLabels adds additional kustomize commonLabels
type : object
images :
description : Images are kustomize image overrides
items :
type : string
type : array
namePrefix :
2020-04-08 17:43:40 +02:00
description : NamePrefix is a prefix appended to resources for
kustomize apps
type : string
nameSuffix :
description : NameSuffix is a suffix appended to resources for
2019-12-19 09:50:18 +11:00
kustomize apps
type : string
type : object
path :
description : Path is a directory path within the Git repository
type : string
plugin :
2020-04-08 17:43:40 +02:00
description : ConfigManagementPlugin holds config management plugin
2019-12-19 09:50:18 +11:00
specific options
properties :
env :
items :
properties :
name :
description : the name, usually uppercase
type : string
value :
description : the 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
name :
type : string
type : object
repoURL :
description : RepoURL is the repository URL of the application manifests
type : string
targetRevision :
2020-04-08 17:43:40 +02:00
description : TargetRevision defines the commit, tag, or branch in
2019-12-19 09:50:18 +11:00
which to sync the application to. If omitted, will sync to HEAD
type : string
required :
2020-04-08 17:43:40 +02:00
- repoURL
2019-12-19 09:50:18 +11:00
type : object
syncPolicy :
description : SyncPolicy controls when a sync will be performed
properties :
automated :
2020-04-08 17:43:40 +02:00
description : Automated will keep an application synced to the target
2019-12-19 09:50:18 +11:00
revision
properties :
prune :
2020-04-08 17:43:40 +02:00
description : 'Prune will prune resources automatically as part
of automated sync (default : false )'
2019-12-19 09:50:18 +11:00
type : boolean
selfHeal :
2020-04-08 17:43:40 +02:00
description: 'SelfHeal enables auto-syncing if (default : false )'
2019-12-19 09:50:18 +11:00
type : boolean
type : object
2020-04-08 17:43:40 +02:00
syncOptions :
description : Options allow youe to specify whole app sync-options
items :
type : string
type : array
2019-12-19 09:50:18 +11:00
type : object
required :
2020-04-08 17:43:40 +02:00
- destination
- project
- source
2019-12-19 09:50:18 +11:00
type : object
status :
2020-04-08 17:43:40 +02:00
description : ApplicationStatus contains information about application sync,
health status
2019-12-19 09:50:18 +11:00
properties :
conditions :
items :
2020-04-08 17:43:40 +02:00
description : ApplicationCondition contains details about current application
condition
2019-12-19 09:50:18 +11:00
properties :
2020-04-08 17:43:40 +02:00
lastTransitionTime :
description : LastTransitionTime is the time the condition was
first observed.
format : date-time
type : string
2019-12-19 09:50:18 +11:00
message :
2020-04-08 17:43:40 +02:00
description : Message contains human-readable message indicating
2019-12-19 09:50:18 +11:00
details about condition
type : string
type :
description : Type is an application condition type
type : string
required :
2020-04-08 17:43:40 +02:00
- message
- type
2019-12-19 09:50:18 +11:00
type : object
type : array
health :
properties :
message :
type : string
status :
type : string
type : object
history :
2020-04-08 17:43:40 +02:00
description : RevisionHistories is a array of history, oldest first and
newest last
2019-12-19 09:50:18 +11:00
items :
2020-04-08 17:43:40 +02:00
description : RevisionHistory contains information relevant to an application
deployment
2019-12-19 09:50:18 +11:00
properties :
deployedAt :
format : date-time
type : string
id :
format : int64
type : integer
revision :
type : string
source :
2020-04-08 17:43:40 +02:00
description : ApplicationSource contains information about github
repository, path within repository and target application environment.
2019-12-19 09:50:18 +11:00
properties :
chart :
description : Chart is a Helm chart name
type : string
directory :
description : Directory holds path/directory specific options
properties :
jsonnet :
2020-04-08 17:43:40 +02:00
description : ApplicationSourceJsonnet holds jsonnet specific
options
2019-12-19 09:50:18 +11:00
properties :
extVars :
2020-04-08 17:43:40 +02:00
description : ExtVars is a list of Jsonnet External
2019-12-19 09:50:18 +11:00
Variables
items :
2020-04-08 17:43:40 +02:00
description : JsonnetVar is a jsonnet variable
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
tlas :
description : TLAS is a list of Jsonnet Top-level Arguments
items :
2020-04-08 17:43:40 +02:00
description : JsonnetVar is a jsonnet variable
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 :
type : boolean
type : object
helm :
description : Helm holds helm specific options
properties :
2020-04-08 17:43:40 +02:00
fileParameters :
description : FileParameters are file parameters to the
helm template
items :
description : HelmFileParameter is a file parameter to
a helm template
properties :
name :
description : Name is the name of the helm parameter
type : string
path :
description : Path is the path value for the helm
parameter
type : string
type : object
type : array
2019-12-19 09:50:18 +11:00
parameters :
description : Parameters are parameters to the helm template
items :
2020-04-08 17:43:40 +02:00
description : HelmParameter is a parameter to a helm
template
2019-12-19 09:50:18 +11:00
properties :
forceString :
2020-04-08 17:43:40 +02:00
description : ForceString determines whether to tell
2019-12-19 09:50:18 +11:00
Helm to interpret booleans and numbers as strings
type : boolean
name :
description : Name is the name of the helm parameter
type : string
value :
description : Value is the value for the helm parameter
type : string
type : object
type : array
releaseName :
2020-04-08 17:43:40 +02:00
description : The Helm release name. If omitted it will
2019-12-19 09:50:18 +11:00
use the application name
type : string
valueFiles :
2020-04-08 17:43:40 +02:00
description : ValuesFiles is a list of Helm value files
2019-12-19 09:50:18 +11:00
to use when generating a template
items :
type : string
type : array
values :
2020-04-08 17:43:40 +02:00
description : Values is Helm values, typically defined
2019-12-19 09:50:18 +11:00
as a block
type : string
type : object
ksonnet :
description : Ksonnet holds ksonnet specific options
properties :
environment :
2020-04-08 17:43:40 +02:00
description : Environment is a ksonnet application environment
2019-12-19 09:50:18 +11:00
name
type : string
parameters :
2020-04-08 17:43:40 +02:00
description : Parameters are a list of ksonnet component
2019-12-19 09:50:18 +11:00
parameter override values
items :
2020-04-08 17:43:40 +02: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 :
commonLabels :
additionalProperties :
type : string
description : CommonLabels adds additional kustomize commonLabels
type : object
images :
description : Images are kustomize image overrides
items :
type : string
type : array
namePrefix :
2020-04-08 17:43:40 +02:00
description : NamePrefix is a prefix appended to resources
for kustomize apps
type : string
nameSuffix :
description : NameSuffix is a suffix appended to resources
2019-12-19 09:50:18 +11:00
for kustomize apps
type : string
type : object
path :
description : Path is a directory path within the Git repository
type : string
plugin :
2020-04-08 17:43:40 +02:00
description : ConfigManagementPlugin holds config management
2019-12-19 09:50:18 +11:00
plugin specific options
properties :
env :
items :
properties :
name :
description : the name, usually uppercase
type : string
value :
description : the 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
name :
type : string
type : object
repoURL :
2020-04-08 17:43:40 +02:00
description : RepoURL is the repository URL of the application
2019-12-19 09:50:18 +11:00
manifests
type : string
targetRevision :
2020-04-08 17:43:40 +02:00
description : TargetRevision defines the commit, tag, or branch
2019-12-19 09:50:18 +11:00
in which to sync the application to. If omitted, will sync
to HEAD
type : string
required :
2020-04-08 17:43:40 +02:00
- repoURL
2019-12-19 09:50:18 +11:00
type : object
required :
2020-04-08 17:43:40 +02:00
- deployedAt
- id
- revision
2019-12-19 09:50:18 +11:00
type : object
type : array
observedAt :
2020-04-08 17:43:40 +02:00
description : ObservedAt indicates when the application state was updated
2019-12-19 09:50:18 +11:00
without querying latest git state
format : date-time
type : string
operationState :
2020-04-08 17:43:40 +02:00
description : OperationState contains information about state of currently
performing operation on application.
2019-12-19 09:50:18 +11:00
properties :
finishedAt :
description : FinishedAt contains time of operation completion
format : date-time
type : string
message :
2020-04-08 17:43:40 +02:00
description : Message hold any pertinent messages when attempting
2019-12-19 09:50:18 +11:00
to perform operation (typically errors).
type : string
operation :
description : Operation is the original requested operation
properties :
2020-04-08 17:43:40 +02:00
initiatedBy :
description : OperationInitiator holds information about the
operation initiator
properties :
automated :
description : Automated is set to true if operation was initiated
automatically by the application controller.
type : boolean
username :
description : Name of a user who started operation.
type : string
type : object
2019-12-19 09:50:18 +11:00
sync :
2020-04-08 17:43:40 +02:00
description : SyncOperation contains sync operation details.
2019-12-19 09:50:18 +11:00
properties :
dryRun :
2020-04-08 17:43:40 +02:00
description : DryRun will perform a `kubectl apply --dry-run`
2019-12-19 09:50:18 +11:00
without actually performing the sync
type : boolean
manifests :
2020-04-08 17:43:40 +02:00
description : Manifests is an optional field that overrides
2019-12-19 09:50:18 +11:00
sync source with a local directory for development
items :
type : string
type : array
prune :
2020-04-08 17:43:40 +02:00
description : Prune deletes resources that are no longer
2019-12-19 09:50:18 +11:00
tracked in git
type : boolean
resources :
description : Resources describes which resources to sync
items :
2020-04-08 17:43:40 +02:00
description : SyncOperationResource contains resources
to sync.
2019-12-19 09:50:18 +11:00
properties :
group :
type : string
kind :
type : string
name :
type : string
required :
2020-04-08 17:43:40 +02:00
- kind
- name
2019-12-19 09:50:18 +11:00
type : object
type : array
revision :
2020-04-08 17:43:40 +02:00
description : Revision is the revision in which to sync the
2019-12-19 09:50:18 +11:00
application to. If omitted, will use the revision specified
in app spec.
type : string
source :
2020-04-08 17:43:40 +02:00
description : Source overrides the source definition set
2019-12-19 09:50:18 +11:00
in the application. This is typically set in a Rollback
operation and nil during a Sync operation
properties :
chart :
description : Chart is a Helm chart name
type : string
directory :
2020-04-08 17:43:40 +02:00
description : Directory holds path/directory specific
2019-12-19 09:50:18 +11:00
options
properties :
jsonnet :
2020-04-08 17:43:40 +02:00
description : ApplicationSourceJsonnet holds jsonnet
specific options
2019-12-19 09:50:18 +11:00
properties :
extVars :
2020-04-08 17:43:40 +02:00
description : ExtVars is a list of Jsonnet External
2019-12-19 09:50:18 +11:00
Variables
items :
2020-04-08 17:43:40 +02:00
description : JsonnetVar is a jsonnet variable
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
tlas :
2020-04-08 17:43:40 +02:00
description : TLAS is a list of Jsonnet Top-level
2019-12-19 09:50:18 +11:00
Arguments
items :
2020-04-08 17:43:40 +02:00
description : JsonnetVar is a jsonnet variable
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 :
type : boolean
type : object
helm :
description : Helm holds helm specific options
properties :
2020-04-08 17:43:40 +02:00
fileParameters :
description : FileParameters are file parameters
to the helm template
items :
description : HelmFileParameter is a file parameter
to a helm template
properties :
name :
description : Name is the name of the helm
parameter
type : string
path :
description : Path is the path value for the
helm parameter
type : string
type : object
type : array
2019-12-19 09:50:18 +11:00
parameters :
2020-04-08 17:43:40 +02:00
description : Parameters are parameters to the helm
2019-12-19 09:50:18 +11:00
template
items :
2020-04-08 17:43:40 +02:00
description : HelmParameter is a parameter to a
helm template
2019-12-19 09:50:18 +11:00
properties :
forceString :
2020-04-08 17:43:40 +02:00
description : ForceString determines whether
2019-12-19 09:50:18 +11:00
to tell Helm to interpret booleans and numbers
as strings
type : boolean
name :
2020-04-08 17:43:40 +02:00
description : Name is the name of the helm
2019-12-19 09:50:18 +11:00
parameter
type : string
value :
2020-04-08 17:43:40 +02:00
description : Value is the value for the helm
2019-12-19 09:50:18 +11:00
parameter
type : string
type : object
type : array
releaseName :
2020-04-08 17:43:40 +02:00
description : The Helm release name. If omitted it
2019-12-19 09:50:18 +11:00
will use the application name
type : string
valueFiles :
2020-04-08 17:43:40 +02:00
description : ValuesFiles is a list of Helm value
2019-12-19 09:50:18 +11:00
files to use when generating a template
items :
type : string
type : array
values :
2020-04-08 17:43:40 +02:00
description : Values is Helm values, typically defined
2019-12-19 09:50:18 +11:00
as a block
type : string
type : object
ksonnet :
description : Ksonnet holds ksonnet specific options
properties :
environment :
2020-04-08 17:43:40 +02:00
description : Environment is a ksonnet application
2019-12-19 09:50:18 +11:00
environment name
type : string
parameters :
2020-04-08 17:43:40 +02:00
description : Parameters are a list of ksonnet component
2019-12-19 09:50:18 +11:00
parameter override values
items :
2020-04-08 17:43:40 +02: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 :
commonLabels :
additionalProperties :
type : string
2020-04-08 17:43:40 +02:00
description : CommonLabels adds additional kustomize
2019-12-19 09:50:18 +11:00
commonLabels
type : object
images :
description : Images are kustomize image overrides
items :
type : string
type : array
namePrefix :
2020-04-08 17:43:40 +02:00
description : NamePrefix is a prefix appended to
resources for kustomize apps
type : string
nameSuffix :
description : NameSuffix is a suffix appended to
2019-12-19 09:50:18 +11:00
resources for kustomize apps
type : string
type : object
path :
2020-04-08 17:43:40 +02:00
description : Path is a directory path within the Git
2019-12-19 09:50:18 +11:00
repository
type : string
plugin :
2020-04-08 17:43:40 +02:00
description : ConfigManagementPlugin holds config management
2019-12-19 09:50:18 +11:00
plugin specific options
properties :
env :
items :
properties :
name :
description : the name, usually uppercase
type : string
value :
description : the 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
name :
type : string
type : object
repoURL :
2020-04-08 17:43:40 +02:00
description : RepoURL is the repository URL of the application
2019-12-19 09:50:18 +11:00
manifests
type : string
targetRevision :
2020-04-08 17:43:40 +02:00
description : TargetRevision defines the commit, tag,
2019-12-19 09:50:18 +11:00
or branch in which to sync the application to. If
omitted, will sync to HEAD
type : string
required :
2020-04-08 17:43:40 +02:00
- repoURL
2019-12-19 09:50:18 +11:00
type : object
2020-04-08 17:43:40 +02:00
syncOptions :
description : SyncOptions provide per-sync sync-options,
e.g. Validate=false
items :
type : string
type : array
2019-12-19 09:50:18 +11:00
syncStrategy :
description : SyncStrategy describes how to perform the sync
properties :
apply :
2020-04-08 17:43:40 +02:00
description : Apply wil perform a `kubectl apply` to
2019-12-19 09:50:18 +11:00
perform the sync.
properties :
force :
2020-04-08 17:43:40 +02:00
description : Force indicates whether or not to supply
2019-12-19 09:50:18 +11:00
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.
type : boolean
type : object
hook :
2020-04-08 17:43:40 +02:00
description : Hook will submit any referenced resources
2019-12-19 09:50:18 +11:00
to perform the sync. This is the default strategy
properties :
force :
2020-04-08 17:43:40 +02:00
description : Force indicates whether or not to supply
2019-12-19 09:50:18 +11:00
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.
type : boolean
type : object
type : object
type : object
type : object
phase :
description : Phase is the current phase of the operation
type : string
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 :
2020-04-08 17:43:40 +02:00
description : Resources holds the sync result of each individual
2019-12-19 09:50:18 +11:00
resource
items :
2020-04-08 17:43:40 +02:00
description : ResourceResult holds the operation result details
of a specific resource
2019-12-19 09:50:18 +11:00
properties :
group :
type : string
hookPhase :
2020-04-08 17:43:40 +02:00
description : 'the state of any operation associated with
2019-12-19 09:50:18 +11:00
this resource OR hook note : can contain values for non-hook
2020-04-08 17:43:40 +02:00
resources'
2019-12-19 09:50:18 +11:00
type : string
hookType :
2020-04-08 17:43:40 +02:00
description : the type of the hook, empty for non-hook
2019-12-19 09:50:18 +11:00
resources
type : string
kind :
type : string
message :
description : message for the last sync OR operation
type : string
name :
type : string
namespace :
type : string
status :
2020-04-08 17:43:40 +02:00
description : the final result of the sync, this is be
2019-12-19 09:50:18 +11:00
empty if the resources is yet to be applied/pruned and
is always zero-value for hooks
type : string
syncPhase :
2020-04-08 17:43:40 +02:00
description : indicates the particular phase of the sync
2019-12-19 09:50:18 +11:00
that this is for
type : string
version :
type : string
required :
2020-04-08 17:43:40 +02:00
- group
- kind
- name
- namespace
- version
2019-12-19 09:50:18 +11:00
type : object
type : array
revision :
description : Revision holds the revision of the sync
type : string
source :
2020-04-08 17:43:40 +02:00
description : Source records the application source information
2019-12-19 09:50:18 +11:00
of the sync, used for comparing auto-sync
properties :
chart :
description : Chart is a Helm chart name
type : string
directory :
description : Directory holds path/directory specific options
properties :
jsonnet :
2020-04-08 17:43:40 +02:00
description : ApplicationSourceJsonnet holds jsonnet
specific options
2019-12-19 09:50:18 +11:00
properties :
extVars :
2020-04-08 17:43:40 +02:00
description : ExtVars is a list of Jsonnet External
2019-12-19 09:50:18 +11:00
Variables
items :
2020-04-08 17:43:40 +02:00
description : JsonnetVar is a jsonnet variable
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
tlas :
2020-04-08 17:43:40 +02:00
description : TLAS is a list of Jsonnet Top-level
2019-12-19 09:50:18 +11:00
Arguments
items :
2020-04-08 17:43:40 +02:00
description : JsonnetVar is a jsonnet variable
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 :
type : boolean
type : object
helm :
description : Helm holds helm specific options
properties :
2020-04-08 17:43:40 +02:00
fileParameters :
description : FileParameters are file parameters to the
helm template
items :
description : HelmFileParameter is a file parameter
to a helm template
properties :
name :
description : Name is the name of the helm parameter
type : string
path :
description : Path is the path value for the helm
parameter
type : string
type : object
type : array
2019-12-19 09:50:18 +11:00
parameters :
description : Parameters are parameters to the helm template
items :
2020-04-08 17:43:40 +02:00
description : HelmParameter is a parameter to a helm
template
2019-12-19 09:50:18 +11:00
properties :
forceString :
2020-04-08 17:43:40 +02:00
description : ForceString determines whether to
2019-12-19 09:50:18 +11:00
tell Helm to interpret booleans and numbers
as strings
type : boolean
name :
description : Name is the name of the helm parameter
type : string
value :
description : Value is the value for the helm parameter
type : string
type : object
type : array
releaseName :
2020-04-08 17:43:40 +02:00
description : The Helm release name. If omitted it will
2019-12-19 09:50:18 +11:00
use the application name
type : string
valueFiles :
2020-04-08 17:43:40 +02:00
description : ValuesFiles is a list of Helm value files
2019-12-19 09:50:18 +11:00
to use when generating a template
items :
type : string
type : array
values :
2020-04-08 17:43:40 +02:00
description : Values is Helm values, typically defined
2019-12-19 09:50:18 +11:00
as a block
type : string
type : object
ksonnet :
description : Ksonnet holds ksonnet specific options
properties :
environment :
2020-04-08 17:43:40 +02:00
description : Environment is a ksonnet application environment
2019-12-19 09:50:18 +11:00
name
type : string
parameters :
2020-04-08 17:43:40 +02:00
description : Parameters are a list of ksonnet component
2019-12-19 09:50:18 +11:00
parameter override values
items :
2020-04-08 17:43:40 +02: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 :
commonLabels :
additionalProperties :
type : string
2020-04-08 17:43:40 +02:00
description : CommonLabels adds additional kustomize
2019-12-19 09:50:18 +11:00
commonLabels
type : object
images :
description : Images are kustomize image overrides
items :
type : string
type : array
namePrefix :
2020-04-08 17:43:40 +02:00
description : NamePrefix is a prefix appended to resources
for kustomize apps
type : string
nameSuffix :
description : NameSuffix is a suffix appended to resources
2019-12-19 09:50:18 +11:00
for kustomize apps
type : string
type : object
path :
description : Path is a directory path within the Git repository
type : string
plugin :
2020-04-08 17:43:40 +02:00
description : ConfigManagementPlugin holds config management
2019-12-19 09:50:18 +11:00
plugin specific options
properties :
env :
items :
properties :
name :
description : the name, usually uppercase
type : string
value :
description : the 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
name :
type : string
type : object
repoURL :
2020-04-08 17:43:40 +02:00
description : RepoURL is the repository URL of the application
2019-12-19 09:50:18 +11:00
manifests
type : string
targetRevision :
2020-04-08 17:43:40 +02:00
description : TargetRevision defines the commit, tag, or
2019-12-19 09:50:18 +11:00
branch in which to sync the application to. If omitted,
will sync to HEAD
type : string
required :
2020-04-08 17:43:40 +02:00
- repoURL
2019-12-19 09:50:18 +11:00
type : object
required :
2020-04-08 17:43:40 +02:00
- revision
2019-12-19 09:50:18 +11:00
type : object
required :
2020-04-08 17:43:40 +02:00
- operation
- phase
- startedAt
2019-12-19 09:50:18 +11:00
type : object
reconciledAt :
2020-04-08 17:43:40 +02:00
description : ReconciledAt indicates when the application state was reconciled
2019-12-19 09:50:18 +11:00
using the latest git version
format : date-time
type : string
resources :
items :
2020-04-08 17:43:40 +02:00
description : ResourceStatus holds the current sync and health status
of a resource
2019-12-19 09:50:18 +11:00
properties :
group :
type : string
health :
properties :
message :
type : string
status :
type : string
type : object
hook :
type : boolean
kind :
type : string
name :
type : string
namespace :
type : string
requiresPruning :
type : boolean
status :
2020-04-08 17:43:40 +02:00
description : SyncStatusCode is a type which represents possible
comparison results
2019-12-19 09:50:18 +11:00
type : string
version :
type : string
type : object
type : array
sourceType :
type : string
summary :
properties :
externalURLs :
2020-04-08 17:43:40 +02:00
description : ExternalURLs holds all external URLs of application
2019-12-19 09:50:18 +11:00
child resources.
items :
type : string
type : array
images :
description : Images holds all images of application child resources.
items :
type : string
type : array
type : object
sync :
2020-04-08 17:43:40 +02:00
description : SyncStatus is a comparison result of application spec and
deployed application.
2019-12-19 09:50:18 +11:00
properties :
comparedTo :
2020-04-08 17:43:40 +02:00
description : ComparedTo contains application source and target which
was used for resources comparison
2019-12-19 09:50:18 +11:00
properties :
destination :
2020-04-08 17:43:40 +02:00
description : ApplicationDestination contains deployment destination
information
2019-12-19 09:50:18 +11:00
properties :
namespace :
2020-04-08 17:43:40 +02:00
description : Namespace overrides the environment namespace
2019-12-19 09:50:18 +11:00
value in the ksonnet app.yaml
type : string
server :
2020-04-08 17:43:40 +02:00
description : Server overrides the environment server value
2019-12-19 09:50:18 +11:00
in the ksonnet app.yaml
type : string
type : object
source :
2020-04-08 17:43:40 +02:00
description : ApplicationSource contains information about github
repository, path within repository and target application
environment.
2019-12-19 09:50:18 +11:00
properties :
chart :
description : Chart is a Helm chart name
type : string
directory :
description : Directory holds path/directory specific options
properties :
jsonnet :
2020-04-08 17:43:40 +02:00
description : ApplicationSourceJsonnet holds jsonnet
specific options
2019-12-19 09:50:18 +11:00
properties :
extVars :
2020-04-08 17:43:40 +02:00
description : ExtVars is a list of Jsonnet External
2019-12-19 09:50:18 +11:00
Variables
items :
2020-04-08 17:43:40 +02:00
description : JsonnetVar is a jsonnet variable
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
tlas :
2020-04-08 17:43:40 +02:00
description : TLAS is a list of Jsonnet Top-level
2019-12-19 09:50:18 +11:00
Arguments
items :
2020-04-08 17:43:40 +02:00
description : JsonnetVar is a jsonnet variable
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 :
type : boolean
type : object
helm :
description : Helm holds helm specific options
properties :
2020-04-08 17:43:40 +02:00
fileParameters :
description : FileParameters are file parameters to the
helm template
items :
description : HelmFileParameter is a file parameter
to a helm template
properties :
name :
description : Name is the name of the helm parameter
type : string
path :
description : Path is the path value for the helm
parameter
type : string
type : object
type : array
2019-12-19 09:50:18 +11:00
parameters :
description : Parameters are parameters to the helm template
items :
2020-04-08 17:43:40 +02:00
description : HelmParameter is a parameter to a helm
template
2019-12-19 09:50:18 +11:00
properties :
forceString :
2020-04-08 17:43:40 +02:00
description : ForceString determines whether to
2019-12-19 09:50:18 +11:00
tell Helm to interpret booleans and numbers
as strings
type : boolean
name :
description : Name is the name of the helm parameter
type : string
value :
description : Value is the value for the helm parameter
type : string
type : object
type : array
releaseName :
2020-04-08 17:43:40 +02:00
description : The Helm release name. If omitted it will
2019-12-19 09:50:18 +11:00
use the application name
type : string
valueFiles :
2020-04-08 17:43:40 +02:00
description : ValuesFiles is a list of Helm value files
2019-12-19 09:50:18 +11:00
to use when generating a template
items :
type : string
type : array
values :
2020-04-08 17:43:40 +02:00
description : Values is Helm values, typically defined
2019-12-19 09:50:18 +11:00
as a block
type : string
type : object
ksonnet :
description : Ksonnet holds ksonnet specific options
properties :
environment :
2020-04-08 17:43:40 +02:00
description : Environment is a ksonnet application environment
2019-12-19 09:50:18 +11:00
name
type : string
parameters :
2020-04-08 17:43:40 +02:00
description : Parameters are a list of ksonnet component
2019-12-19 09:50:18 +11:00
parameter override values
items :
2020-04-08 17:43:40 +02: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 :
commonLabels :
additionalProperties :
type : string
2020-04-08 17:43:40 +02:00
description : CommonLabels adds additional kustomize
2019-12-19 09:50:18 +11:00
commonLabels
type : object
images :
description : Images are kustomize image overrides
items :
type : string
type : array
namePrefix :
2020-04-08 17:43:40 +02:00
description : NamePrefix is a prefix appended to resources
for kustomize apps
type : string
nameSuffix :
description : NameSuffix is a suffix appended to resources
2019-12-19 09:50:18 +11:00
for kustomize apps
type : string
type : object
path :
description : Path is a directory path within the Git repository
type : string
plugin :
2020-04-08 17:43:40 +02:00
description : ConfigManagementPlugin holds config management
2019-12-19 09:50:18 +11:00
plugin specific options
properties :
env :
items :
properties :
name :
description : the name, usually uppercase
type : string
value :
description : the 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
name :
type : string
type : object
repoURL :
2020-04-08 17:43:40 +02:00
description : RepoURL is the repository URL of the application
2019-12-19 09:50:18 +11:00
manifests
type : string
targetRevision :
2020-04-08 17:43:40 +02:00
description : TargetRevision defines the commit, tag, or
2019-12-19 09:50:18 +11:00
branch in which to sync the application to. If omitted,
will sync to HEAD
type : string
required :
2020-04-08 17:43:40 +02:00
- repoURL
2019-12-19 09:50:18 +11:00
type : object
required :
2020-04-08 17:43:40 +02:00
- destination
- source
2019-12-19 09:50:18 +11:00
type : object
revision :
type : string
status :
2020-04-08 17:43:40 +02:00
description : SyncStatusCode is a type which represents possible
comparison results
2019-12-19 09:50:18 +11:00
type : string
required :
2020-04-08 17:43:40 +02:00
- status
2019-12-19 09:50:18 +11:00
type : object
type : object
required :
2020-04-08 17:43:40 +02:00
- metadata
- spec
2019-12-19 09:50:18 +11:00
type : object
2020-04-08 17:43:40 +02:00
version : v1alpha1
2019-12-19 09:50:18 +11:00
versions :
2020-04-08 17:43:40 +02:00
- name : v1alpha1
served : true
storage : true