Rollout [argoproj.io/v1alpha1]

Type
object
Required
spec

Specification

PropertyTypeDescription
apiVersionstring
kindstring
metadataObjectMeta

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

specobject
statusobject

.spec

Type
object
PropertyTypeDescription
analysisobject
minReadySecondsinteger
pausedboolean
progressDeadlineAbortboolean
progressDeadlineSecondsinteger
replicasinteger
restartAtstring
revisionHistoryLimitinteger
rollbackWindowobject
selectorobject
strategyobject
templateobject
workloadRefobject

.spec.analysis

Type
object
PropertyTypeDescription
successfulRunHistoryLimitinteger
unsuccessfulRunHistoryLimitinteger

.spec.rollbackWindow

Type
object
PropertyTypeDescription
revisionsinteger

.spec.selector

Type
object
PropertyTypeDescription
matchExpressionsarray
matchLabelsobject

.spec.selector.matchExpressions

Type
array

.spec.selector.matchExpressions[]

Type
object
Required
keyoperator
PropertyTypeDescription
keystring
operatorstring
valuesarray

.spec.selector.matchExpressions[].values

Type
array

.spec.selector.matchExpressions[].values[]

Type
string

.spec.selector.matchLabels

Type
object

.spec.strategy

Type
object
PropertyTypeDescription
blueGreenobject
canaryobject

.spec.strategy.blueGreen

Type
object
Required
activeService
PropertyTypeDescription
abortScaleDownDelaySecondsinteger
activeMetadataobject
activeServicestring
antiAffinityobject
autoPromotionEnabledboolean
autoPromotionSecondsinteger
maxUnavailableinteger|string
postPromotionAnalysisobject
prePromotionAnalysisobject
previewMetadataobject
previewReplicaCountinteger
previewServicestring
scaleDownDelayRevisionLimitinteger
scaleDownDelaySecondsinteger

.spec.strategy.blueGreen.activeMetadata

Type
object
PropertyTypeDescription
annotationsobject
labelsobject

.spec.strategy.blueGreen.activeMetadata.annotations

Type
object

.spec.strategy.blueGreen.activeMetadata.labels

Type
object

.spec.strategy.blueGreen.antiAffinity

Type
object
PropertyTypeDescription
preferredDuringSchedulingIgnoredDuringExecutionobject
requiredDuringSchedulingIgnoredDuringExecutionobject

.spec.strategy.blueGreen.antiAffinity.preferredDuringSchedulingIgnoredDuringExecution

Type
object
Required
weight
PropertyTypeDescription
weightinteger

.spec.strategy.blueGreen.antiAffinity.requiredDuringSchedulingIgnoredDuringExecution

Type
object

.spec.strategy.blueGreen.postPromotionAnalysis

Type
object
PropertyTypeDescription
analysisRunMetadataobject
argsarray
dryRunarray
measurementRetentionarray
templatesarray

.spec.strategy.blueGreen.postPromotionAnalysis.analysisRunMetadata

Type
object
PropertyTypeDescription
annotationsobject
labelsobject

.spec.strategy.blueGreen.postPromotionAnalysis.analysisRunMetadata.annotations

Type
object

.spec.strategy.blueGreen.postPromotionAnalysis.analysisRunMetadata.labels

Type
object

.spec.strategy.blueGreen.postPromotionAnalysis.args

Type
array

.spec.strategy.blueGreen.postPromotionAnalysis.args[]

Type
object
Required
name
PropertyTypeDescription
namestring
valuestring
valueFromobject

.spec.strategy.blueGreen.postPromotionAnalysis.args[].valueFrom

Type
object
PropertyTypeDescription
fieldRefobject
podTemplateHashValuestring

.spec.strategy.blueGreen.postPromotionAnalysis.args[].valueFrom.fieldRef

Type
object
Required
fieldPath
PropertyTypeDescription
fieldPathstring

.spec.strategy.blueGreen.postPromotionAnalysis.dryRun

Type
array

.spec.strategy.blueGreen.postPromotionAnalysis.dryRun[]

Type
object
Required
metricName
PropertyTypeDescription
metricNamestring

.spec.strategy.blueGreen.postPromotionAnalysis.measurementRetention

Type
array

.spec.strategy.blueGreen.postPromotionAnalysis.measurementRetention[]

Type
object
Required
limitmetricName
PropertyTypeDescription
limitinteger
metricNamestring

.spec.strategy.blueGreen.postPromotionAnalysis.templates

Type
array

.spec.strategy.blueGreen.postPromotionAnalysis.templates[]

Type
object
PropertyTypeDescription
clusterScopeboolean
templateNamestring

.spec.strategy.blueGreen.prePromotionAnalysis

Type
object
PropertyTypeDescription
analysisRunMetadataobject
argsarray
dryRunarray
measurementRetentionarray
templatesarray

.spec.strategy.blueGreen.prePromotionAnalysis.analysisRunMetadata

Type
object
PropertyTypeDescription
annotationsobject
labelsobject

.spec.strategy.blueGreen.prePromotionAnalysis.analysisRunMetadata.annotations

Type
object

.spec.strategy.blueGreen.prePromotionAnalysis.analysisRunMetadata.labels

Type
object

.spec.strategy.blueGreen.prePromotionAnalysis.args

Type
array

.spec.strategy.blueGreen.prePromotionAnalysis.args[]

Type
object
Required
name
PropertyTypeDescription
namestring
valuestring
valueFromobject

.spec.strategy.blueGreen.prePromotionAnalysis.args[].valueFrom

Type
object
PropertyTypeDescription
fieldRefobject
podTemplateHashValuestring

.spec.strategy.blueGreen.prePromotionAnalysis.args[].valueFrom.fieldRef

Type
object
Required
fieldPath
PropertyTypeDescription
fieldPathstring

.spec.strategy.blueGreen.prePromotionAnalysis.dryRun

Type
array

.spec.strategy.blueGreen.prePromotionAnalysis.dryRun[]

Type
object
Required
metricName
PropertyTypeDescription
metricNamestring

.spec.strategy.blueGreen.prePromotionAnalysis.measurementRetention

Type
array

.spec.strategy.blueGreen.prePromotionAnalysis.measurementRetention[]

Type
object
Required
limitmetricName
PropertyTypeDescription
limitinteger
metricNamestring

.spec.strategy.blueGreen.prePromotionAnalysis.templates

Type
array

.spec.strategy.blueGreen.prePromotionAnalysis.templates[]

Type
object
PropertyTypeDescription
clusterScopeboolean
templateNamestring

.spec.strategy.blueGreen.previewMetadata

Type
object
PropertyTypeDescription
annotationsobject
labelsobject

.spec.strategy.blueGreen.previewMetadata.annotations

Type
object

.spec.strategy.blueGreen.previewMetadata.labels

Type
object

.spec.strategy.canary

Type
object
PropertyTypeDescription
abortScaleDownDelaySecondsinteger
analysisobject
antiAffinityobject
canaryMetadataobject
canaryServicestring
dynamicStableScaleboolean
maxSurgeinteger|string
maxUnavailableinteger|string
minPodsPerReplicaSetinteger
pingPongobject
scaleDownDelayRevisionLimitinteger
scaleDownDelaySecondsinteger
stableMetadataobject
stableServicestring
stepsarray
trafficRoutingobject

.spec.strategy.canary.analysis

Type
object
PropertyTypeDescription
analysisRunMetadataobject
argsarray
dryRunarray
measurementRetentionarray
startingStepinteger
templatesarray

.spec.strategy.canary.analysis.analysisRunMetadata

Type
object
PropertyTypeDescription
annotationsobject
labelsobject

.spec.strategy.canary.analysis.analysisRunMetadata.annotations

Type
object

.spec.strategy.canary.analysis.analysisRunMetadata.labels

Type
object

.spec.strategy.canary.analysis.args

Type
array

.spec.strategy.canary.analysis.args[]

Type
object
Required
name
PropertyTypeDescription
namestring
valuestring
valueFromobject

.spec.strategy.canary.analysis.args[].valueFrom

Type
object
PropertyTypeDescription
fieldRefobject
podTemplateHashValuestring

.spec.strategy.canary.analysis.args[].valueFrom.fieldRef

Type
object
Required
fieldPath
PropertyTypeDescription
fieldPathstring

.spec.strategy.canary.analysis.dryRun

Type
array

.spec.strategy.canary.analysis.dryRun[]

Type
object
Required
metricName
PropertyTypeDescription
metricNamestring

.spec.strategy.canary.analysis.measurementRetention

Type
array

.spec.strategy.canary.analysis.measurementRetention[]

Type
object
Required
limitmetricName
PropertyTypeDescription
limitinteger
metricNamestring

.spec.strategy.canary.analysis.templates

Type
array

.spec.strategy.canary.analysis.templates[]

Type
object
PropertyTypeDescription
clusterScopeboolean
templateNamestring

.spec.strategy.canary.antiAffinity

Type
object
PropertyTypeDescription
preferredDuringSchedulingIgnoredDuringExecutionobject
requiredDuringSchedulingIgnoredDuringExecutionobject

.spec.strategy.canary.antiAffinity.preferredDuringSchedulingIgnoredDuringExecution

Type
object
Required
weight
PropertyTypeDescription
weightinteger

.spec.strategy.canary.antiAffinity.requiredDuringSchedulingIgnoredDuringExecution

Type
object

.spec.strategy.canary.canaryMetadata

Type
object
PropertyTypeDescription
annotationsobject
labelsobject

.spec.strategy.canary.canaryMetadata.annotations

Type
object

.spec.strategy.canary.canaryMetadata.labels

Type
object

.spec.strategy.canary.pingPong

Type
object
Required
pingServicepongService
PropertyTypeDescription
pingServicestring
pongServicestring

.spec.strategy.canary.stableMetadata

Type
object
PropertyTypeDescription
annotationsobject
labelsobject

.spec.strategy.canary.stableMetadata.annotations

Type
object

.spec.strategy.canary.stableMetadata.labels

Type
object

.spec.strategy.canary.steps

Type
array

.spec.strategy.canary.steps[]

Type
object
PropertyTypeDescription
analysisobject
experimentobject
pauseobject
pluginobject
setCanaryScaleobject
setHeaderRouteobject
setMirrorRouteobject
setWeightinteger

.spec.strategy.canary.steps[].analysis

Type
object
PropertyTypeDescription
analysisRunMetadataobject
argsarray
dryRunarray
measurementRetentionarray
templatesarray

.spec.strategy.canary.steps[].analysis.analysisRunMetadata

Type
object
PropertyTypeDescription
annotationsobject
labelsobject

.spec.strategy.canary.steps[].analysis.analysisRunMetadata.annotations

Type
object

.spec.strategy.canary.steps[].analysis.analysisRunMetadata.labels

Type
object

.spec.strategy.canary.steps[].analysis.args

Type
array

.spec.strategy.canary.steps[].analysis.args[]

Type
object
Required
name
PropertyTypeDescription
namestring
valuestring
valueFromobject

.spec.strategy.canary.steps[].analysis.args[].valueFrom

Type
object
PropertyTypeDescription
fieldRefobject
podTemplateHashValuestring

.spec.strategy.canary.steps[].analysis.args[].valueFrom.fieldRef

Type
object
Required
fieldPath
PropertyTypeDescription
fieldPathstring

.spec.strategy.canary.steps[].analysis.dryRun

Type
array

.spec.strategy.canary.steps[].analysis.dryRun[]

Type
object
Required
metricName
PropertyTypeDescription
metricNamestring

.spec.strategy.canary.steps[].analysis.measurementRetention

Type
array

.spec.strategy.canary.steps[].analysis.measurementRetention[]

Type
object
Required
limitmetricName
PropertyTypeDescription
limitinteger
metricNamestring

.spec.strategy.canary.steps[].analysis.templates

Type
array

.spec.strategy.canary.steps[].analysis.templates[]

Type
object
PropertyTypeDescription
clusterScopeboolean
templateNamestring

.spec.strategy.canary.steps[].experiment

Type
object
Required
templates
PropertyTypeDescription
analysesarray
analysisRunMetadataobject
dryRunarray
durationstring
templatesarray

.spec.strategy.canary.steps[].experiment.analyses

Type
array

.spec.strategy.canary.steps[].experiment.analyses[]

Type
object
Required
nametemplateName
PropertyTypeDescription
argsarray
clusterScopeboolean
namestring
requiredForCompletionboolean
templateNamestring

.spec.strategy.canary.steps[].experiment.analyses[].args

Type
array

.spec.strategy.canary.steps[].experiment.analyses[].args[]

Type
object
Required
name
PropertyTypeDescription
namestring
valuestring
valueFromobject

.spec.strategy.canary.steps[].experiment.analyses[].args[].valueFrom

Type
object
PropertyTypeDescription
fieldRefobject
podTemplateHashValuestring

.spec.strategy.canary.steps[].experiment.analyses[].args[].valueFrom.fieldRef

Type
object
Required
fieldPath
PropertyTypeDescription
fieldPathstring

.spec.strategy.canary.steps[].experiment.analysisRunMetadata

Type
object
PropertyTypeDescription
annotationsobject
labelsobject

.spec.strategy.canary.steps[].experiment.analysisRunMetadata.annotations

Type
object

.spec.strategy.canary.steps[].experiment.analysisRunMetadata.labels

Type
object

.spec.strategy.canary.steps[].experiment.dryRun

Type
array

.spec.strategy.canary.steps[].experiment.dryRun[]

Type
object
Required
metricName
PropertyTypeDescription
metricNamestring

.spec.strategy.canary.steps[].experiment.templates

Type
array

.spec.strategy.canary.steps[].experiment.templates[]

Type
object
Required
namespecRef
PropertyTypeDescription
metadataObjectMeta

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

namestring
replicasinteger
selectorobject
serviceobject
specRefstring
weightinteger

.spec.strategy.canary.steps[].experiment.templates[].selector

Type
object
PropertyTypeDescription
matchExpressionsarray
matchLabelsobject

.spec.strategy.canary.steps[].experiment.templates[].selector.matchExpressions

Type
array

.spec.strategy.canary.steps[].experiment.templates[].selector.matchExpressions[]

Type
object
Required
keyoperator
PropertyTypeDescription
keystring
operatorstring
valuesarray

.spec.strategy.canary.steps[].experiment.templates[].selector.matchExpressions[].values

Type
array

.spec.strategy.canary.steps[].experiment.templates[].selector.matchExpressions[].values[]

Type
string

.spec.strategy.canary.steps[].experiment.templates[].selector.matchLabels

Type
object

.spec.strategy.canary.steps[].experiment.templates[].service

Type
object
PropertyTypeDescription
namestring

.spec.strategy.canary.steps[].pause

Type
object
PropertyTypeDescription
durationinteger|string

.spec.strategy.canary.steps[].plugin

Type
object
Required
name
PropertyTypeDescription
configobject
namestring

.spec.strategy.canary.steps[].plugin.config

Type
object

.spec.strategy.canary.steps[].setCanaryScale

Type
object
PropertyTypeDescription
matchTrafficWeightboolean
replicasinteger
weightinteger

.spec.strategy.canary.steps[].setHeaderRoute

Type
object
PropertyTypeDescription
matcharray
namestring

.spec.strategy.canary.steps[].setHeaderRoute.match

Type
array

.spec.strategy.canary.steps[].setHeaderRoute.match[]

Type
object
Required
headerNameheaderValue
PropertyTypeDescription
headerNamestring
headerValueobject

.spec.strategy.canary.steps[].setHeaderRoute.match[].headerValue

Type
object
PropertyTypeDescription
exactstring
prefixstring
regexstring

.spec.strategy.canary.steps[].setMirrorRoute

Type
object
Required
name
PropertyTypeDescription
matcharray
namestring
percentageinteger

.spec.strategy.canary.steps[].setMirrorRoute.match

Type
array

.spec.strategy.canary.steps[].setMirrorRoute.match[]

Type
object
PropertyTypeDescription
headersobject
methodobject
pathobject

.spec.strategy.canary.steps[].setMirrorRoute.match[].headers

Type
object

.spec.strategy.canary.steps[].setMirrorRoute.match[].method

Type
object
PropertyTypeDescription
exactstring
prefixstring
regexstring

.spec.strategy.canary.steps[].setMirrorRoute.match[].path

Type
object
PropertyTypeDescription
exactstring
prefixstring
regexstring

.spec.strategy.canary.trafficRouting

Type
object
PropertyTypeDescription
albobject
ambassadorobject
apisixobject
appMeshobject
istioobject
managedRoutesarray
maxTrafficWeightinteger
nginxobject
pluginsobject
smiobject
traefikobject

.spec.strategy.canary.trafficRouting.alb

Type
object
Required
servicePort
PropertyTypeDescription
annotationPrefixstring
ingressstring
ingressesarray
rootServicestring
servicePortinteger
stickinessConfigobject

.spec.strategy.canary.trafficRouting.alb.ingresses

Type
array

.spec.strategy.canary.trafficRouting.alb.ingresses[]

Type
string

.spec.strategy.canary.trafficRouting.alb.stickinessConfig

Type
object
Required
durationSecondsenabled
PropertyTypeDescription
durationSecondsinteger
enabledboolean

.spec.strategy.canary.trafficRouting.ambassador

Type
object
Required
mappings
PropertyTypeDescription
mappingsarray

.spec.strategy.canary.trafficRouting.ambassador.mappings

Type
array

.spec.strategy.canary.trafficRouting.ambassador.mappings[]

Type
string

.spec.strategy.canary.trafficRouting.apisix

Type
object
PropertyTypeDescription
routeobject

.spec.strategy.canary.trafficRouting.apisix.route

Type
object
Required
name
PropertyTypeDescription
namestring
rulesarray

.spec.strategy.canary.trafficRouting.apisix.route.rules

Type
array

.spec.strategy.canary.trafficRouting.apisix.route.rules[]

Type
string

.spec.strategy.canary.trafficRouting.appMesh

Type
object
PropertyTypeDescription
virtualNodeGroupobject
virtualServiceobject

.spec.strategy.canary.trafficRouting.appMesh.virtualNodeGroup

Type
object
Required
canaryVirtualNodeRefstableVirtualNodeRef
PropertyTypeDescription
canaryVirtualNodeRefobject
stableVirtualNodeRefobject

.spec.strategy.canary.trafficRouting.appMesh.virtualNodeGroup.canaryVirtualNodeRef

Type
object
Required
name
PropertyTypeDescription
namestring

.spec.strategy.canary.trafficRouting.appMesh.virtualNodeGroup.stableVirtualNodeRef

Type
object
Required
name
PropertyTypeDescription
namestring

.spec.strategy.canary.trafficRouting.appMesh.virtualService

Type
object
Required
name
PropertyTypeDescription
namestring
routesarray

.spec.strategy.canary.trafficRouting.appMesh.virtualService.routes

Type
array

.spec.strategy.canary.trafficRouting.appMesh.virtualService.routes[]

Type
string

.spec.strategy.canary.trafficRouting.istio

Type
object
PropertyTypeDescription
destinationRuleobject
virtualServiceobject
virtualServicesarray

.spec.strategy.canary.trafficRouting.istio.destinationRule

Type
object
Required
canarySubsetNamenamestableSubsetName
PropertyTypeDescription
canarySubsetNamestring
namestring
stableSubsetNamestring

.spec.strategy.canary.trafficRouting.istio.virtualService

Type
object
Required
name
PropertyTypeDescription
namestring
routesarray
tcpRoutesarray
tlsRoutesarray

.spec.strategy.canary.trafficRouting.istio.virtualService.routes

Type
array

.spec.strategy.canary.trafficRouting.istio.virtualService.routes[]

Type
string

.spec.strategy.canary.trafficRouting.istio.virtualService.tcpRoutes

Type
array

.spec.strategy.canary.trafficRouting.istio.virtualService.tcpRoutes[]

Type
object
PropertyTypeDescription
portinteger

.spec.strategy.canary.trafficRouting.istio.virtualService.tlsRoutes

Type
array

.spec.strategy.canary.trafficRouting.istio.virtualService.tlsRoutes[]

Type
object
PropertyTypeDescription
portinteger
sniHostsarray

.spec.strategy.canary.trafficRouting.istio.virtualService.tlsRoutes[].sniHosts

Type
array

.spec.strategy.canary.trafficRouting.istio.virtualService.tlsRoutes[].sniHosts[]

Type
string

.spec.strategy.canary.trafficRouting.istio.virtualServices

Type
array

.spec.strategy.canary.trafficRouting.istio.virtualServices[]

Type
object
Required
name
PropertyTypeDescription
namestring
routesarray
tcpRoutesarray
tlsRoutesarray

.spec.strategy.canary.trafficRouting.istio.virtualServices[].routes

Type
array

.spec.strategy.canary.trafficRouting.istio.virtualServices[].routes[]

Type
string

.spec.strategy.canary.trafficRouting.istio.virtualServices[].tcpRoutes

Type
array

.spec.strategy.canary.trafficRouting.istio.virtualServices[].tcpRoutes[]

Type
object
PropertyTypeDescription
portinteger

.spec.strategy.canary.trafficRouting.istio.virtualServices[].tlsRoutes

Type
array

.spec.strategy.canary.trafficRouting.istio.virtualServices[].tlsRoutes[]

Type
object
PropertyTypeDescription
portinteger
sniHostsarray

.spec.strategy.canary.trafficRouting.istio.virtualServices[].tlsRoutes[].sniHosts

Type
array

.spec.strategy.canary.trafficRouting.istio.virtualServices[].tlsRoutes[].sniHosts[]

Type
string

.spec.strategy.canary.trafficRouting.managedRoutes

Type
array

.spec.strategy.canary.trafficRouting.managedRoutes[]

Type
object
Required
name
PropertyTypeDescription
namestring

.spec.strategy.canary.trafficRouting.nginx

Type
object
PropertyTypeDescription
additionalIngressAnnotationsobject
annotationPrefixstring
canaryIngressAnnotationsobject
stableIngressstring
stableIngressesarray

.spec.strategy.canary.trafficRouting.nginx.additionalIngressAnnotations

Type
object

.spec.strategy.canary.trafficRouting.nginx.canaryIngressAnnotations

Type
object

.spec.strategy.canary.trafficRouting.nginx.stableIngresses

Type
array

.spec.strategy.canary.trafficRouting.nginx.stableIngresses[]

Type
string

.spec.strategy.canary.trafficRouting.plugins

Type
object

.spec.strategy.canary.trafficRouting.smi

Type
object
PropertyTypeDescription
rootServicestring
trafficSplitNamestring

.spec.strategy.canary.trafficRouting.traefik

Type
object
Required
weightedTraefikServiceName
PropertyTypeDescription
weightedTraefikServiceNamestring

.spec.template

Type
object
PropertyTypeDescription
metadataObjectMeta

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

specobject

.spec.template.spec

Type
object
Required
containers
PropertyTypeDescription
activeDeadlineSecondsinteger
affinityobject
automountServiceAccountTokenboolean
containersarray
dnsConfigobject
dnsPolicystring
enableServiceLinksboolean
ephemeralContainersarray
hostAliasesarray
hostIPCboolean
hostNetworkboolean
hostPIDboolean
hostUsersboolean
hostnamestring
imagePullSecretsarray
initContainersarray
nodeNamestring
nodeSelectorobject
osobject
overheadobject
preemptionPolicystring
priorityinteger
priorityClassNamestring
readinessGatesarray
resourceClaimsarray
restartPolicystring
runtimeClassNamestring
schedulerNamestring
schedulingGatesarray
securityContextobject
serviceAccountstring
serviceAccountNamestring
setHostnameAsFQDNboolean
shareProcessNamespaceboolean
subdomainstring
terminationGracePeriodSecondsinteger
tolerationsarray
topologySpreadConstraintsarray
volumesarray

.spec.template.spec.affinity

Type
object
PropertyTypeDescription
nodeAffinityobject
podAffinityobject
podAntiAffinityobject

.spec.template.spec.affinity.nodeAffinity

Type
object
PropertyTypeDescription
preferredDuringSchedulingIgnoredDuringExecutionarray
requiredDuringSchedulingIgnoredDuringExecutionobject

.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

Type
array

.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

Type
object
Required
preferenceweight
PropertyTypeDescription
preferenceobject
weightinteger

.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference

Type
object
PropertyTypeDescription
matchExpressionsarray
matchFieldsarray

.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions

Type
array

.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[]

Type
object
Required
keyoperator
PropertyTypeDescription
keystring
operatorstring
valuesarray

.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[].values

Type
array

.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[].values[]

Type
string

.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields

Type
array

.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[]

Type
object
Required
keyoperator
PropertyTypeDescription
keystring
operatorstring
valuesarray

.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[].values

Type
array

.spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[].values[]

Type
string

.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

Type
object
Required
nodeSelectorTerms
PropertyTypeDescription
nodeSelectorTermsarray

.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

Type
array

.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[]

Type
object
PropertyTypeDescription
matchExpressionsarray
matchFieldsarray

.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions

Type
array

.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[]

Type
object
Required
keyoperator
PropertyTypeDescription
keystring
operatorstring
valuesarray

.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[].values

Type
array

.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[].values[]

Type
string

.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields

Type
array

.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[]

Type
object
Required
keyoperator
PropertyTypeDescription
keystring
operatorstring
valuesarray

.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[].values

Type
array

.spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[].values[]

Type
string

.spec.template.spec.affinity.podAffinity

Type
object
PropertyTypeDescription
preferredDuringSchedulingIgnoredDuringExecutionarray
requiredDuringSchedulingIgnoredDuringExecutionarray

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

Type
array

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

Type
object
Required
podAffinityTermweight
PropertyTypeDescription
podAffinityTermobject
weightinteger

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm

Type
object
Required
topologyKey
PropertyTypeDescription
labelSelectorobject
matchLabelKeysarray
mismatchLabelKeysarray
namespaceSelectorobject
namespacesarray
topologyKeystring

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector

Type
object
PropertyTypeDescription
matchExpressionsarray
matchLabelsobject

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions

Type
array

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]

Type
object
Required
keyoperator
PropertyTypeDescription
keystring
operatorstring
valuesarray

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[].values

Type
array

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[].values[]

Type
string

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchLabels

Type
object

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.matchLabelKeys

Type
array

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.matchLabelKeys[]

Type
string

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.mismatchLabelKeys

Type
array

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.mismatchLabelKeys[]

Type
string

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector

Type
object
PropertyTypeDescription
matchExpressionsarray
matchLabelsobject

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions

Type
array

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]

Type
object
Required
keyoperator
PropertyTypeDescription
keystring
operatorstring
valuesarray

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[].values

Type
array

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[].values[]

Type
string

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchLabels

Type
object

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaces

Type
array

.spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaces[]

Type
string

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

Type
array

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

Type
object
Required
topologyKey
PropertyTypeDescription
labelSelectorobject
matchLabelKeysarray
mismatchLabelKeysarray
namespaceSelectorobject
namespacesarray
topologyKeystring

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector

Type
object
PropertyTypeDescription
matchExpressionsarray
matchLabelsobject

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions

Type
array

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]

Type
object
Required
keyoperator
PropertyTypeDescription
keystring
operatorstring
valuesarray

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[].values

Type
array

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[].values[]

Type
string

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchLabels

Type
object

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].matchLabelKeys

Type
array

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].matchLabelKeys[]

Type
string

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].mismatchLabelKeys

Type
array

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].mismatchLabelKeys[]

Type
string

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector

Type
object
PropertyTypeDescription
matchExpressionsarray
matchLabelsobject

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions

Type
array

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]

Type
object
Required
keyoperator
PropertyTypeDescription
keystring
operatorstring
valuesarray

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[].values

Type
array

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[].values[]

Type
string

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchLabels

Type
object

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaces

Type
array

.spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaces[]

Type
string

.spec.template.spec.affinity.podAntiAffinity

Type
object
PropertyTypeDescription
preferredDuringSchedulingIgnoredDuringExecutionarray
requiredDuringSchedulingIgnoredDuringExecutionarray

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

Type
array

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

Type
object
Required
podAffinityTermweight
PropertyTypeDescription
podAffinityTermobject
weightinteger

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm

Type
object
Required
topologyKey
PropertyTypeDescription
labelSelectorobject
matchLabelKeysarray
mismatchLabelKeysarray
namespaceSelectorobject
namespacesarray
topologyKeystring

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector

Type
object
PropertyTypeDescription
matchExpressionsarray
matchLabelsobject

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions

Type
array

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]

Type
object
Required
keyoperator
PropertyTypeDescription
keystring
operatorstring
valuesarray

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[].values

Type
array

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[].values[]

Type
string

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchLabels

Type
object

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.matchLabelKeys

Type
array

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.matchLabelKeys[]

Type
string

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.mismatchLabelKeys

Type
array

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.mismatchLabelKeys[]

Type
string

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector

Type
object
PropertyTypeDescription
matchExpressionsarray
matchLabelsobject

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions

Type
array

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]

Type
object
Required
keyoperator
PropertyTypeDescription
keystring
operatorstring
valuesarray

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[].values

Type
array

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[].values[]

Type
string

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchLabels

Type
object

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaces

Type
array

.spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaces[]

Type
string

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

Type
array

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

Type
object
Required
topologyKey
PropertyTypeDescription
labelSelectorobject
matchLabelKeysarray
mismatchLabelKeysarray
namespaceSelectorobject
namespacesarray
topologyKeystring

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector

Type
object
PropertyTypeDescription
matchExpressionsarray
matchLabelsobject

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions

Type
array

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]

Type
object
Required
keyoperator
PropertyTypeDescription
keystring
operatorstring
valuesarray

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[].values

Type
array

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[].values[]

Type
string

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchLabels

Type
object

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].matchLabelKeys

Type
array

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].matchLabelKeys[]

Type
string

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].mismatchLabelKeys

Type
array

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].mismatchLabelKeys[]

Type
string

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector

Type
object
PropertyTypeDescription
matchExpressionsarray
matchLabelsobject

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions

Type
array

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]

Type
object
Required
keyoperator
PropertyTypeDescription
keystring
operatorstring
valuesarray

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[].values

Type
array

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[].values[]

Type
string

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchLabels

Type
object

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaces

Type
array

.spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaces[]

Type
string

.spec.template.spec.containers

Type
array

.spec.template.spec.containers[]

Type
object
Required
name
PropertyTypeDescription
argsarray
commandarray
envarray
envFromarray
imagestring
imagePullPolicystring
lifecycleobject
livenessProbeobject
namestring
portsarray
readinessProbeobject
resizePolicyarray
resourcesobject
restartPolicystring
securityContextobject
startupProbeobject
stdinboolean
stdinOnceboolean
terminationMessagePathstring
terminationMessagePolicystring
ttyboolean
volumeDevicesarray
volumeMountsarray
workingDirstring

.spec.template.spec.containers[].args

Type
array

.spec.template.spec.containers[].args[]

Type
string

.spec.template.spec.containers[].command

Type
array

.spec.template.spec.containers[].command[]

Type
string

.spec.template.spec.containers[].env

Type
array

.spec.template.spec.containers[].env[]

Type
object
Required
name
PropertyTypeDescription
namestring
valuestring
valueFromobject

.spec.template.spec.containers[].env[].valueFrom

Type
object
PropertyTypeDescription
configMapKeyRefobject
fieldRefobject
resourceFieldRefobject
secretKeyRefobject

.spec.template.spec.containers[].env[].valueFrom.configMapKeyRef

Type
object
Required
key
PropertyTypeDescription
keystring
namestring
optionalboolean

.spec.template.spec.containers[].env[].valueFrom.fieldRef

Type
object
Required
fieldPath
PropertyTypeDescription
apiVersionstring
fieldPathstring

.spec.template.spec.containers[].env[].valueFrom.resourceFieldRef

Type
object
Required
resource
PropertyTypeDescription
containerNamestring
divisorinteger|string
resourcestring

.spec.template.spec.containers[].env[].valueFrom.secretKeyRef

Type
object
Required
key
PropertyTypeDescription
keystring
namestring
optionalboolean

.spec.template.spec.containers[].envFrom

Type
array

.spec.template.spec.containers[].envFrom[]

Type
object
PropertyTypeDescription
configMapRefobject
prefixstring
secretRefobject

.spec.template.spec.containers[].envFrom[].configMapRef

Type
object
PropertyTypeDescription
namestring
optionalboolean

.spec.template.spec.containers[].envFrom[].secretRef

Type
object
PropertyTypeDescription
namestring
optionalboolean

.spec.template.spec.containers[].lifecycle

Type
object
PropertyTypeDescription
postStartobject
preStopobject

.spec.template.spec.containers[].lifecycle.postStart

Type
object
PropertyTypeDescription
execobject
httpGetobject
sleepobject
tcpSocketobject

.spec.template.spec.containers[].lifecycle.postStart.exec

Type
object
PropertyTypeDescription
commandarray

.spec.template.spec.containers[].lifecycle.postStart.exec.command

Type
array

.spec.template.spec.containers[].lifecycle.postStart.exec.command[]

Type
string

.spec.template.spec.containers[].lifecycle.postStart.httpGet

Type
object
Required
port
PropertyTypeDescription
hoststring
httpHeadersarray
pathstring
portinteger|string
schemestring

.spec.template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders

Type
array

.spec.template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders[]

Type
object
Required
namevalue
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.containers[].lifecycle.postStart.sleep

Type
object
Required
seconds
PropertyTypeDescription
secondsinteger

.spec.template.spec.containers[].lifecycle.postStart.tcpSocket

Type
object
Required
port
PropertyTypeDescription
hoststring
portinteger|string

.spec.template.spec.containers[].lifecycle.preStop

Type
object
PropertyTypeDescription
execobject
httpGetobject
sleepobject
tcpSocketobject

.spec.template.spec.containers[].lifecycle.preStop.exec

Type
object
PropertyTypeDescription
commandarray

.spec.template.spec.containers[].lifecycle.preStop.exec.command

Type
array

.spec.template.spec.containers[].lifecycle.preStop.exec.command[]

Type
string

.spec.template.spec.containers[].lifecycle.preStop.httpGet

Type
object
Required
port
PropertyTypeDescription
hoststring
httpHeadersarray
pathstring
portinteger|string
schemestring

.spec.template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders

Type
array

.spec.template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders[]

Type
object
Required
namevalue
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.containers[].lifecycle.preStop.sleep

Type
object
Required
seconds
PropertyTypeDescription
secondsinteger

.spec.template.spec.containers[].lifecycle.preStop.tcpSocket

Type
object
Required
port
PropertyTypeDescription
hoststring
portinteger|string

.spec.template.spec.containers[].livenessProbe

Type
object
PropertyTypeDescription
execobject
failureThresholdinteger
grpcobject
httpGetobject
initialDelaySecondsinteger
periodSecondsinteger
successThresholdinteger
tcpSocketobject
terminationGracePeriodSecondsinteger
timeoutSecondsinteger

.spec.template.spec.containers[].livenessProbe.exec

Type
object
PropertyTypeDescription
commandarray

.spec.template.spec.containers[].livenessProbe.exec.command

Type
array

.spec.template.spec.containers[].livenessProbe.exec.command[]

Type
string

.spec.template.spec.containers[].livenessProbe.grpc

Type
object
Required
port
PropertyTypeDescription
portinteger
servicestring

.spec.template.spec.containers[].livenessProbe.httpGet

Type
object
Required
port
PropertyTypeDescription
hoststring
httpHeadersarray
pathstring
portinteger|string
schemestring

.spec.template.spec.containers[].livenessProbe.httpGet.httpHeaders

Type
array

.spec.template.spec.containers[].livenessProbe.httpGet.httpHeaders[]

Type
object
Required
namevalue
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.containers[].livenessProbe.tcpSocket

Type
object
Required
port
PropertyTypeDescription
hoststring
portinteger|string

.spec.template.spec.containers[].ports

Type
array

.spec.template.spec.containers[].ports[]

Type
object
Required
containerPort
PropertyTypeDescription
containerPortinteger
hostIPstring
hostPortinteger
namestring
protocolstring

.spec.template.spec.containers[].readinessProbe

Type
object
PropertyTypeDescription
execobject
failureThresholdinteger
grpcobject
httpGetobject
initialDelaySecondsinteger
periodSecondsinteger
successThresholdinteger
tcpSocketobject
terminationGracePeriodSecondsinteger
timeoutSecondsinteger

.spec.template.spec.containers[].readinessProbe.exec

Type
object
PropertyTypeDescription
commandarray

.spec.template.spec.containers[].readinessProbe.exec.command

Type
array

.spec.template.spec.containers[].readinessProbe.exec.command[]

Type
string

.spec.template.spec.containers[].readinessProbe.grpc

Type
object
Required
port
PropertyTypeDescription
portinteger
servicestring

.spec.template.spec.containers[].readinessProbe.httpGet

Type
object
Required
port
PropertyTypeDescription
hoststring
httpHeadersarray
pathstring
portinteger|string
schemestring

.spec.template.spec.containers[].readinessProbe.httpGet.httpHeaders

Type
array

.spec.template.spec.containers[].readinessProbe.httpGet.httpHeaders[]

Type
object
Required
namevalue
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.containers[].readinessProbe.tcpSocket

Type
object
Required
port
PropertyTypeDescription
hoststring
portinteger|string

.spec.template.spec.containers[].resizePolicy

Type
array

.spec.template.spec.containers[].resizePolicy[]

Type
object
Required
resourceNamerestartPolicy
PropertyTypeDescription
resourceNamestring
restartPolicystring

.spec.template.spec.containers[].resources

Type
object
PropertyTypeDescription
claimsarray
limits
requests

.spec.template.spec.containers[].resources.claims

Type
array

.spec.template.spec.containers[].resources.claims[]

Type
object
Required
name
PropertyTypeDescription
namestring

.spec.template.spec.containers[].securityContext

Type
object
PropertyTypeDescription
allowPrivilegeEscalationboolean
capabilitiesobject
privilegedboolean
procMountstring
readOnlyRootFilesystemboolean
runAsGroupinteger
runAsNonRootboolean
runAsUserinteger
seLinuxOptionsobject
seccompProfileobject
windowsOptionsobject

.spec.template.spec.containers[].securityContext.capabilities

Type
object
PropertyTypeDescription
addarray
droparray

.spec.template.spec.containers[].securityContext.capabilities.add

Type
array

.spec.template.spec.containers[].securityContext.capabilities.add[]

Type
string

.spec.template.spec.containers[].securityContext.capabilities.drop

Type
array

.spec.template.spec.containers[].securityContext.capabilities.drop[]

Type
string

.spec.template.spec.containers[].securityContext.seLinuxOptions

Type
object
PropertyTypeDescription
levelstring
rolestring
typestring
userstring

.spec.template.spec.containers[].securityContext.seccompProfile

Type
object
Required
type
PropertyTypeDescription
localhostProfilestring
typestring

.spec.template.spec.containers[].securityContext.windowsOptions

Type
object
PropertyTypeDescription
gmsaCredentialSpecstring
gmsaCredentialSpecNamestring
hostProcessboolean
runAsUserNamestring

.spec.template.spec.containers[].startupProbe

Type
object
PropertyTypeDescription
execobject
failureThresholdinteger
grpcobject
httpGetobject
initialDelaySecondsinteger
periodSecondsinteger
successThresholdinteger
tcpSocketobject
terminationGracePeriodSecondsinteger
timeoutSecondsinteger

.spec.template.spec.containers[].startupProbe.exec

Type
object
PropertyTypeDescription
commandarray

.spec.template.spec.containers[].startupProbe.exec.command

Type
array

.spec.template.spec.containers[].startupProbe.exec.command[]

Type
string

.spec.template.spec.containers[].startupProbe.grpc

Type
object
Required
port
PropertyTypeDescription
portinteger
servicestring

.spec.template.spec.containers[].startupProbe.httpGet

Type
object
Required
port
PropertyTypeDescription
hoststring
httpHeadersarray
pathstring
portinteger|string
schemestring

.spec.template.spec.containers[].startupProbe.httpGet.httpHeaders

Type
array

.spec.template.spec.containers[].startupProbe.httpGet.httpHeaders[]

Type
object
Required
namevalue
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.containers[].startupProbe.tcpSocket

Type
object
Required
port
PropertyTypeDescription
hoststring
portinteger|string

.spec.template.spec.containers[].volumeDevices

Type
array

.spec.template.spec.containers[].volumeDevices[]

Type
object
Required
devicePathname
PropertyTypeDescription
devicePathstring
namestring

.spec.template.spec.containers[].volumeMounts

Type
array

.spec.template.spec.containers[].volumeMounts[]

Type
object
Required
mountPathname
PropertyTypeDescription
mountPathstring
mountPropagationstring
namestring
readOnlyboolean
subPathstring
subPathExprstring

.spec.template.spec.dnsConfig

Type
object
PropertyTypeDescription
nameserversarray
optionsarray
searchesarray

.spec.template.spec.dnsConfig.nameservers

Type
array

.spec.template.spec.dnsConfig.nameservers[]

Type
string

.spec.template.spec.dnsConfig.options

Type
array

.spec.template.spec.dnsConfig.options[]

Type
object
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.dnsConfig.searches

Type
array

.spec.template.spec.dnsConfig.searches[]

Type
string

.spec.template.spec.ephemeralContainers

Type
array

.spec.template.spec.ephemeralContainers[]

Type
object
Required
name
PropertyTypeDescription
argsarray
commandarray
envarray
envFromarray
imagestring
imagePullPolicystring
lifecycleobject
livenessProbeobject
namestring
portsarray
readinessProbeobject
resizePolicyarray
resourcesobject
restartPolicystring
securityContextobject
startupProbeobject
stdinboolean
stdinOnceboolean
targetContainerNamestring
terminationMessagePathstring
terminationMessagePolicystring
ttyboolean
volumeDevicesarray
volumeMountsarray
workingDirstring

.spec.template.spec.ephemeralContainers[].args

Type
array

.spec.template.spec.ephemeralContainers[].args[]

Type
string

.spec.template.spec.ephemeralContainers[].command

Type
array

.spec.template.spec.ephemeralContainers[].command[]

Type
string

.spec.template.spec.ephemeralContainers[].env

Type
array

.spec.template.spec.ephemeralContainers[].env[]

Type
object
Required
name
PropertyTypeDescription
namestring
valuestring
valueFromobject

.spec.template.spec.ephemeralContainers[].env[].valueFrom

Type
object
PropertyTypeDescription
configMapKeyRefobject
fieldRefobject
resourceFieldRefobject
secretKeyRefobject

.spec.template.spec.ephemeralContainers[].env[].valueFrom.configMapKeyRef

Type
object
Required
key
PropertyTypeDescription
keystring
namestring
optionalboolean

.spec.template.spec.ephemeralContainers[].env[].valueFrom.fieldRef

Type
object
Required
fieldPath
PropertyTypeDescription
apiVersionstring
fieldPathstring

.spec.template.spec.ephemeralContainers[].env[].valueFrom.resourceFieldRef

Type
object
Required
resource
PropertyTypeDescription
containerNamestring
divisorinteger|string
resourcestring

.spec.template.spec.ephemeralContainers[].env[].valueFrom.secretKeyRef

Type
object
Required
key
PropertyTypeDescription
keystring
namestring
optionalboolean

.spec.template.spec.ephemeralContainers[].envFrom

Type
array

.spec.template.spec.ephemeralContainers[].envFrom[]

Type
object
PropertyTypeDescription
configMapRefobject
prefixstring
secretRefobject

.spec.template.spec.ephemeralContainers[].envFrom[].configMapRef

Type
object
PropertyTypeDescription
namestring
optionalboolean

.spec.template.spec.ephemeralContainers[].envFrom[].secretRef

Type
object
PropertyTypeDescription
namestring
optionalboolean

.spec.template.spec.ephemeralContainers[].lifecycle

Type
object
PropertyTypeDescription
postStartobject
preStopobject

.spec.template.spec.ephemeralContainers[].lifecycle.postStart

Type
object
PropertyTypeDescription
execobject
httpGetobject
sleepobject
tcpSocketobject

.spec.template.spec.ephemeralContainers[].lifecycle.postStart.exec

Type
object
PropertyTypeDescription
commandarray

.spec.template.spec.ephemeralContainers[].lifecycle.postStart.exec.command

Type
array

.spec.template.spec.ephemeralContainers[].lifecycle.postStart.exec.command[]

Type
string

.spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet

Type
object
Required
port
PropertyTypeDescription
hoststring
httpHeadersarray
pathstring
portinteger|string
schemestring

.spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders

Type
array

.spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders[]

Type
object
Required
namevalue
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.ephemeralContainers[].lifecycle.postStart.sleep

Type
object
Required
seconds
PropertyTypeDescription
secondsinteger

.spec.template.spec.ephemeralContainers[].lifecycle.postStart.tcpSocket

Type
object
Required
port
PropertyTypeDescription
hoststring
portinteger|string

.spec.template.spec.ephemeralContainers[].lifecycle.preStop

Type
object
PropertyTypeDescription
execobject
httpGetobject
sleepobject
tcpSocketobject

.spec.template.spec.ephemeralContainers[].lifecycle.preStop.exec

Type
object
PropertyTypeDescription
commandarray

.spec.template.spec.ephemeralContainers[].lifecycle.preStop.exec.command

Type
array

.spec.template.spec.ephemeralContainers[].lifecycle.preStop.exec.command[]

Type
string

.spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet

Type
object
Required
port
PropertyTypeDescription
hoststring
httpHeadersarray
pathstring
portinteger|string
schemestring

.spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders

Type
array

.spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders[]

Type
object
Required
namevalue
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.ephemeralContainers[].lifecycle.preStop.sleep

Type
object
Required
seconds
PropertyTypeDescription
secondsinteger

.spec.template.spec.ephemeralContainers[].lifecycle.preStop.tcpSocket

Type
object
Required
port
PropertyTypeDescription
hoststring
portinteger|string

.spec.template.spec.ephemeralContainers[].livenessProbe

Type
object
PropertyTypeDescription
execobject
failureThresholdinteger
grpcobject
httpGetobject
initialDelaySecondsinteger
periodSecondsinteger
successThresholdinteger
tcpSocketobject
terminationGracePeriodSecondsinteger
timeoutSecondsinteger

.spec.template.spec.ephemeralContainers[].livenessProbe.exec

Type
object
PropertyTypeDescription
commandarray

.spec.template.spec.ephemeralContainers[].livenessProbe.exec.command

Type
array

.spec.template.spec.ephemeralContainers[].livenessProbe.exec.command[]

Type
string

.spec.template.spec.ephemeralContainers[].livenessProbe.grpc

Type
object
Required
port
PropertyTypeDescription
portinteger
servicestring

.spec.template.spec.ephemeralContainers[].livenessProbe.httpGet

Type
object
Required
port
PropertyTypeDescription
hoststring
httpHeadersarray
pathstring
portinteger|string
schemestring

.spec.template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders

Type
array

.spec.template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders[]

Type
object
Required
namevalue
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.ephemeralContainers[].livenessProbe.tcpSocket

Type
object
Required
port
PropertyTypeDescription
hoststring
portinteger|string

.spec.template.spec.ephemeralContainers[].ports

Type
array

.spec.template.spec.ephemeralContainers[].ports[]

Type
object
Required
containerPort
PropertyTypeDescription
containerPortinteger
hostIPstring
hostPortinteger
namestring
protocolstring

.spec.template.spec.ephemeralContainers[].readinessProbe

Type
object
PropertyTypeDescription
execobject
failureThresholdinteger
grpcobject
httpGetobject
initialDelaySecondsinteger
periodSecondsinteger
successThresholdinteger
tcpSocketobject
terminationGracePeriodSecondsinteger
timeoutSecondsinteger

.spec.template.spec.ephemeralContainers[].readinessProbe.exec

Type
object
PropertyTypeDescription
commandarray

.spec.template.spec.ephemeralContainers[].readinessProbe.exec.command

Type
array

.spec.template.spec.ephemeralContainers[].readinessProbe.exec.command[]

Type
string

.spec.template.spec.ephemeralContainers[].readinessProbe.grpc

Type
object
Required
port
PropertyTypeDescription
portinteger
servicestring

.spec.template.spec.ephemeralContainers[].readinessProbe.httpGet

Type
object
Required
port
PropertyTypeDescription
hoststring
httpHeadersarray
pathstring
portinteger|string
schemestring

.spec.template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders

Type
array

.spec.template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders[]

Type
object
Required
namevalue
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.ephemeralContainers[].readinessProbe.tcpSocket

Type
object
Required
port
PropertyTypeDescription
hoststring
portinteger|string

.spec.template.spec.ephemeralContainers[].resizePolicy

Type
array

.spec.template.spec.ephemeralContainers[].resizePolicy[]

Type
object
Required
resourceNamerestartPolicy
PropertyTypeDescription
resourceNamestring
restartPolicystring

.spec.template.spec.ephemeralContainers[].resources

Type
object
PropertyTypeDescription
claimsarray
limits
requests

.spec.template.spec.ephemeralContainers[].resources.claims

Type
array

.spec.template.spec.ephemeralContainers[].resources.claims[]

Type
object
Required
name
PropertyTypeDescription
namestring

.spec.template.spec.ephemeralContainers[].securityContext

Type
object
PropertyTypeDescription
allowPrivilegeEscalationboolean
capabilitiesobject
privilegedboolean
procMountstring
readOnlyRootFilesystemboolean
runAsGroupinteger
runAsNonRootboolean
runAsUserinteger
seLinuxOptionsobject
seccompProfileobject
windowsOptionsobject

.spec.template.spec.ephemeralContainers[].securityContext.capabilities

Type
object
PropertyTypeDescription
addarray
droparray

.spec.template.spec.ephemeralContainers[].securityContext.capabilities.add

Type
array

.spec.template.spec.ephemeralContainers[].securityContext.capabilities.add[]

Type
string

.spec.template.spec.ephemeralContainers[].securityContext.capabilities.drop

Type
array

.spec.template.spec.ephemeralContainers[].securityContext.capabilities.drop[]

Type
string

.spec.template.spec.ephemeralContainers[].securityContext.seLinuxOptions

Type
object
PropertyTypeDescription
levelstring
rolestring
typestring
userstring

.spec.template.spec.ephemeralContainers[].securityContext.seccompProfile

Type
object
Required
type
PropertyTypeDescription
localhostProfilestring
typestring

.spec.template.spec.ephemeralContainers[].securityContext.windowsOptions

Type
object
PropertyTypeDescription
gmsaCredentialSpecstring
gmsaCredentialSpecNamestring
hostProcessboolean
runAsUserNamestring

.spec.template.spec.ephemeralContainers[].startupProbe

Type
object
PropertyTypeDescription
execobject
failureThresholdinteger
grpcobject
httpGetobject
initialDelaySecondsinteger
periodSecondsinteger
successThresholdinteger
tcpSocketobject
terminationGracePeriodSecondsinteger
timeoutSecondsinteger

.spec.template.spec.ephemeralContainers[].startupProbe.exec

Type
object
PropertyTypeDescription
commandarray

.spec.template.spec.ephemeralContainers[].startupProbe.exec.command

Type
array

.spec.template.spec.ephemeralContainers[].startupProbe.exec.command[]

Type
string

.spec.template.spec.ephemeralContainers[].startupProbe.grpc

Type
object
Required
port
PropertyTypeDescription
portinteger
servicestring

.spec.template.spec.ephemeralContainers[].startupProbe.httpGet

Type
object
Required
port
PropertyTypeDescription
hoststring
httpHeadersarray
pathstring
portinteger|string
schemestring

.spec.template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders

Type
array

.spec.template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders[]

Type
object
Required
namevalue
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.ephemeralContainers[].startupProbe.tcpSocket

Type
object
Required
port
PropertyTypeDescription
hoststring
portinteger|string

.spec.template.spec.ephemeralContainers[].volumeDevices

Type
array

.spec.template.spec.ephemeralContainers[].volumeDevices[]

Type
object
Required
devicePathname
PropertyTypeDescription
devicePathstring
namestring

.spec.template.spec.ephemeralContainers[].volumeMounts

Type
array

.spec.template.spec.ephemeralContainers[].volumeMounts[]

Type
object
Required
mountPathname
PropertyTypeDescription
mountPathstring
mountPropagationstring
namestring
readOnlyboolean
subPathstring
subPathExprstring

.spec.template.spec.hostAliases

Type
array

.spec.template.spec.hostAliases[]

Type
object
PropertyTypeDescription
hostnamesarray
ipstring

.spec.template.spec.hostAliases[].hostnames

Type
array

.spec.template.spec.hostAliases[].hostnames[]

Type
string

.spec.template.spec.imagePullSecrets

Type
array

.spec.template.spec.imagePullSecrets[]

Type
object
PropertyTypeDescription
namestring

.spec.template.spec.initContainers

Type
array

.spec.template.spec.initContainers[]

Type
object
Required
name
PropertyTypeDescription
argsarray
commandarray
envarray
envFromarray
imagestring
imagePullPolicystring
lifecycleobject
livenessProbeobject
namestring
portsarray
readinessProbeobject
resizePolicyarray
resourcesobject
restartPolicystring
securityContextobject
startupProbeobject
stdinboolean
stdinOnceboolean
terminationMessagePathstring
terminationMessagePolicystring
ttyboolean
volumeDevicesarray
volumeMountsarray
workingDirstring

.spec.template.spec.initContainers[].args

Type
array

.spec.template.spec.initContainers[].args[]

Type
string

.spec.template.spec.initContainers[].command

Type
array

.spec.template.spec.initContainers[].command[]

Type
string

.spec.template.spec.initContainers[].env

Type
array

.spec.template.spec.initContainers[].env[]

Type
object
Required
name
PropertyTypeDescription
namestring
valuestring
valueFromobject

.spec.template.spec.initContainers[].env[].valueFrom

Type
object
PropertyTypeDescription
configMapKeyRefobject
fieldRefobject
resourceFieldRefobject
secretKeyRefobject

.spec.template.spec.initContainers[].env[].valueFrom.configMapKeyRef

Type
object
Required
key
PropertyTypeDescription
keystring
namestring
optionalboolean

.spec.template.spec.initContainers[].env[].valueFrom.fieldRef

Type
object
Required
fieldPath
PropertyTypeDescription
apiVersionstring
fieldPathstring

.spec.template.spec.initContainers[].env[].valueFrom.resourceFieldRef

Type
object
Required
resource
PropertyTypeDescription
containerNamestring
divisorinteger|string
resourcestring

.spec.template.spec.initContainers[].env[].valueFrom.secretKeyRef

Type
object
Required
key
PropertyTypeDescription
keystring
namestring
optionalboolean

.spec.template.spec.initContainers[].envFrom

Type
array

.spec.template.spec.initContainers[].envFrom[]

Type
object
PropertyTypeDescription
configMapRefobject
prefixstring
secretRefobject

.spec.template.spec.initContainers[].envFrom[].configMapRef

Type
object
PropertyTypeDescription
namestring
optionalboolean

.spec.template.spec.initContainers[].envFrom[].secretRef

Type
object
PropertyTypeDescription
namestring
optionalboolean

.spec.template.spec.initContainers[].lifecycle

Type
object
PropertyTypeDescription
postStartobject
preStopobject

.spec.template.spec.initContainers[].lifecycle.postStart

Type
object
PropertyTypeDescription
execobject
httpGetobject
sleepobject
tcpSocketobject

.spec.template.spec.initContainers[].lifecycle.postStart.exec

Type
object
PropertyTypeDescription
commandarray

.spec.template.spec.initContainers[].lifecycle.postStart.exec.command

Type
array

.spec.template.spec.initContainers[].lifecycle.postStart.exec.command[]

Type
string

.spec.template.spec.initContainers[].lifecycle.postStart.httpGet

Type
object
Required
port
PropertyTypeDescription
hoststring
httpHeadersarray
pathstring
portinteger|string
schemestring

.spec.template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders

Type
array

.spec.template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[]

Type
object
Required
namevalue
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.initContainers[].lifecycle.postStart.sleep

Type
object
Required
seconds
PropertyTypeDescription
secondsinteger

.spec.template.spec.initContainers[].lifecycle.postStart.tcpSocket

Type
object
Required
port
PropertyTypeDescription
hoststring
portinteger|string

.spec.template.spec.initContainers[].lifecycle.preStop

Type
object
PropertyTypeDescription
execobject
httpGetobject
sleepobject
tcpSocketobject

.spec.template.spec.initContainers[].lifecycle.preStop.exec

Type
object
PropertyTypeDescription
commandarray

.spec.template.spec.initContainers[].lifecycle.preStop.exec.command

Type
array

.spec.template.spec.initContainers[].lifecycle.preStop.exec.command[]

Type
string

.spec.template.spec.initContainers[].lifecycle.preStop.httpGet

Type
object
Required
port
PropertyTypeDescription
hoststring
httpHeadersarray
pathstring
portinteger|string
schemestring

.spec.template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders

Type
array

.spec.template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[]

Type
object
Required
namevalue
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.initContainers[].lifecycle.preStop.sleep

Type
object
Required
seconds
PropertyTypeDescription
secondsinteger

.spec.template.spec.initContainers[].lifecycle.preStop.tcpSocket

Type
object
Required
port
PropertyTypeDescription
hoststring
portinteger|string

.spec.template.spec.initContainers[].livenessProbe

Type
object
PropertyTypeDescription
execobject
failureThresholdinteger
grpcobject
httpGetobject
initialDelaySecondsinteger
periodSecondsinteger
successThresholdinteger
tcpSocketobject
terminationGracePeriodSecondsinteger
timeoutSecondsinteger

.spec.template.spec.initContainers[].livenessProbe.exec

Type
object
PropertyTypeDescription
commandarray

.spec.template.spec.initContainers[].livenessProbe.exec.command

Type
array

.spec.template.spec.initContainers[].livenessProbe.exec.command[]

Type
string

.spec.template.spec.initContainers[].livenessProbe.grpc

Type
object
Required
port
PropertyTypeDescription
portinteger
servicestring

.spec.template.spec.initContainers[].livenessProbe.httpGet

Type
object
Required
port
PropertyTypeDescription
hoststring
httpHeadersarray
pathstring
portinteger|string
schemestring

.spec.template.spec.initContainers[].livenessProbe.httpGet.httpHeaders

Type
array

.spec.template.spec.initContainers[].livenessProbe.httpGet.httpHeaders[]

Type
object
Required
namevalue
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.initContainers[].livenessProbe.tcpSocket

Type
object
Required
port
PropertyTypeDescription
hoststring
portinteger|string

.spec.template.spec.initContainers[].ports

Type
array

.spec.template.spec.initContainers[].ports[]

Type
object
Required
containerPort
PropertyTypeDescription
containerPortinteger
hostIPstring
hostPortinteger
namestring
protocolstring

.spec.template.spec.initContainers[].readinessProbe

Type
object
PropertyTypeDescription
execobject
failureThresholdinteger
grpcobject
httpGetobject
initialDelaySecondsinteger
periodSecondsinteger
successThresholdinteger
tcpSocketobject
terminationGracePeriodSecondsinteger
timeoutSecondsinteger

.spec.template.spec.initContainers[].readinessProbe.exec

Type
object
PropertyTypeDescription
commandarray

.spec.template.spec.initContainers[].readinessProbe.exec.command

Type
array

.spec.template.spec.initContainers[].readinessProbe.exec.command[]

Type
string

.spec.template.spec.initContainers[].readinessProbe.grpc

Type
object
Required
port
PropertyTypeDescription
portinteger
servicestring

.spec.template.spec.initContainers[].readinessProbe.httpGet

Type
object
Required
port
PropertyTypeDescription
hoststring
httpHeadersarray
pathstring
portinteger|string
schemestring

.spec.template.spec.initContainers[].readinessProbe.httpGet.httpHeaders

Type
array

.spec.template.spec.initContainers[].readinessProbe.httpGet.httpHeaders[]

Type
object
Required
namevalue
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.initContainers[].readinessProbe.tcpSocket

Type
object
Required
port
PropertyTypeDescription
hoststring
portinteger|string

.spec.template.spec.initContainers[].resizePolicy

Type
array

.spec.template.spec.initContainers[].resizePolicy[]

Type
object
Required
resourceNamerestartPolicy
PropertyTypeDescription
resourceNamestring
restartPolicystring

.spec.template.spec.initContainers[].resources

Type
object
PropertyTypeDescription
claimsarray
limits
requests

.spec.template.spec.initContainers[].resources.claims

Type
array

.spec.template.spec.initContainers[].resources.claims[]

Type
object
Required
name
PropertyTypeDescription
namestring

.spec.template.spec.initContainers[].securityContext

Type
object
PropertyTypeDescription
allowPrivilegeEscalationboolean
capabilitiesobject
privilegedboolean
procMountstring
readOnlyRootFilesystemboolean
runAsGroupinteger
runAsNonRootboolean
runAsUserinteger
seLinuxOptionsobject
seccompProfileobject
windowsOptionsobject

.spec.template.spec.initContainers[].securityContext.capabilities

Type
object
PropertyTypeDescription
addarray
droparray

.spec.template.spec.initContainers[].securityContext.capabilities.add

Type
array

.spec.template.spec.initContainers[].securityContext.capabilities.add[]

Type
string

.spec.template.spec.initContainers[].securityContext.capabilities.drop

Type
array

.spec.template.spec.initContainers[].securityContext.capabilities.drop[]

Type
string

.spec.template.spec.initContainers[].securityContext.seLinuxOptions

Type
object
PropertyTypeDescription
levelstring
rolestring
typestring
userstring

.spec.template.spec.initContainers[].securityContext.seccompProfile

Type
object
Required
type
PropertyTypeDescription
localhostProfilestring
typestring

.spec.template.spec.initContainers[].securityContext.windowsOptions

Type
object
PropertyTypeDescription
gmsaCredentialSpecstring
gmsaCredentialSpecNamestring
hostProcessboolean
runAsUserNamestring

.spec.template.spec.initContainers[].startupProbe

Type
object
PropertyTypeDescription
execobject
failureThresholdinteger
grpcobject
httpGetobject
initialDelaySecondsinteger
periodSecondsinteger
successThresholdinteger
tcpSocketobject
terminationGracePeriodSecondsinteger
timeoutSecondsinteger

.spec.template.spec.initContainers[].startupProbe.exec

Type
object
PropertyTypeDescription
commandarray

.spec.template.spec.initContainers[].startupProbe.exec.command

Type
array

.spec.template.spec.initContainers[].startupProbe.exec.command[]

Type
string

.spec.template.spec.initContainers[].startupProbe.grpc

Type
object
Required
port
PropertyTypeDescription
portinteger
servicestring

.spec.template.spec.initContainers[].startupProbe.httpGet

Type
object
Required
port
PropertyTypeDescription
hoststring
httpHeadersarray
pathstring
portinteger|string
schemestring

.spec.template.spec.initContainers[].startupProbe.httpGet.httpHeaders

Type
array

.spec.template.spec.initContainers[].startupProbe.httpGet.httpHeaders[]

Type
object
Required
namevalue
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.initContainers[].startupProbe.tcpSocket

Type
object
Required
port
PropertyTypeDescription
hoststring
portinteger|string

.spec.template.spec.initContainers[].volumeDevices

Type
array

.spec.template.spec.initContainers[].volumeDevices[]

Type
object
Required
devicePathname
PropertyTypeDescription
devicePathstring
namestring

.spec.template.spec.initContainers[].volumeMounts

Type
array

.spec.template.spec.initContainers[].volumeMounts[]

Type
object
Required
mountPathname
PropertyTypeDescription
mountPathstring
mountPropagationstring
namestring
readOnlyboolean
subPathstring
subPathExprstring

.spec.template.spec.nodeSelector

Type
object

.spec.template.spec.os

Type
object
Required
name
PropertyTypeDescription
namestring

.spec.template.spec.overhead

Type
object

.spec.template.spec.readinessGates

Type
array

.spec.template.spec.readinessGates[]

Type
object
Required
conditionType
PropertyTypeDescription
conditionTypestring

.spec.template.spec.resourceClaims

Type
array

.spec.template.spec.resourceClaims[]

Type
object
Required
name
PropertyTypeDescription
namestring
sourceobject

.spec.template.spec.resourceClaims[].source

Type
object
PropertyTypeDescription
resourceClaimNamestring
resourceClaimTemplateNamestring

.spec.template.spec.schedulingGates

Type
array

.spec.template.spec.schedulingGates[]

Type
object
Required
name
PropertyTypeDescription
namestring

.spec.template.spec.securityContext

Type
object
PropertyTypeDescription
fsGroupinteger
fsGroupChangePolicystring
runAsGroupinteger
runAsNonRootboolean
runAsUserinteger
seLinuxOptionsobject
seccompProfileobject
supplementalGroupsarray
sysctlsarray
windowsOptionsobject

.spec.template.spec.securityContext.seLinuxOptions

Type
object
PropertyTypeDescription
levelstring
rolestring
typestring
userstring

.spec.template.spec.securityContext.seccompProfile

Type
object
Required
type
PropertyTypeDescription
localhostProfilestring
typestring

.spec.template.spec.securityContext.supplementalGroups

Type
array

.spec.template.spec.securityContext.supplementalGroups[]

Type
integer

.spec.template.spec.securityContext.sysctls

Type
array

.spec.template.spec.securityContext.sysctls[]

Type
object
Required
namevalue
PropertyTypeDescription
namestring
valuestring

.spec.template.spec.securityContext.windowsOptions

Type
object
PropertyTypeDescription
gmsaCredentialSpecstring
gmsaCredentialSpecNamestring
hostProcessboolean
runAsUserNamestring

.spec.template.spec.tolerations

Type
array

.spec.template.spec.tolerations[]

Type
object
PropertyTypeDescription
effectstring
keystring
operatorstring
tolerationSecondsinteger
valuestring

.spec.template.spec.topologySpreadConstraints

Type
array

.spec.template.spec.topologySpreadConstraints[]

Type
object
Required
maxSkewtopologyKeywhenUnsatisfiable
PropertyTypeDescription
labelSelectorobject
matchLabelKeysarray
maxSkewinteger
minDomainsinteger
nodeAffinityPolicystring
nodeTaintsPolicystring
topologyKeystring
whenUnsatisfiablestring

.spec.template.spec.topologySpreadConstraints[].labelSelector

Type
object
PropertyTypeDescription
matchExpressionsarray
matchLabelsobject

.spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions

Type
array

.spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions[]

Type
object
Required
keyoperator
PropertyTypeDescription
keystring
operatorstring
valuesarray

.spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions[].values

Type
array

.spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions[].values[]

Type
string

.spec.template.spec.topologySpreadConstraints[].labelSelector.matchLabels

Type
object

.spec.template.spec.topologySpreadConstraints[].matchLabelKeys

Type
array

.spec.template.spec.topologySpreadConstraints[].matchLabelKeys[]

Type
string

.spec.template.spec.volumes

Type
array

.spec.template.spec.volumes[]

Type

.spec.workloadRef

Type
object
PropertyTypeDescription
apiVersionstring
kindstring
namestring
scaleDownstring

.status

Type
object
PropertyTypeDescription
HPAReplicasinteger
abortboolean
abortedAtstring
albobject
albsarray
availableReplicasinteger
blueGreenobject
canaryobject
collisionCountinteger
conditionsarray
controllerPauseboolean
currentPodHashstring
currentStepHashstring
currentStepIndexinteger
messagestring
observedGenerationstring
pauseConditionsarray
phasestring
promoteFullboolean
readyReplicasinteger
replicasinteger
restartedAtstring
selectorstring
stableRSstring
updatedReplicasinteger
workloadObservedGenerationstring

.status.alb

Type
object
PropertyTypeDescription
canaryTargetGroupobject
ingressstring
loadBalancerobject
stableTargetGroupobject

.status.alb.canaryTargetGroup

Type
object
Required
arnname
PropertyTypeDescription
arnstring
fullNamestring
namestring

.status.alb.loadBalancer

Type
object
Required
arnname
PropertyTypeDescription
arnstring
fullNamestring
namestring

.status.alb.stableTargetGroup

Type
object
Required
arnname
PropertyTypeDescription
arnstring
fullNamestring
namestring

.status.albs

Type
array

.status.albs[]

Type
object
PropertyTypeDescription
canaryTargetGroupobject
ingressstring
loadBalancerobject
stableTargetGroupobject

.status.albs[].canaryTargetGroup

Type
object
Required
arnname
PropertyTypeDescription
arnstring
fullNamestring
namestring

.status.albs[].loadBalancer

Type
object
Required
arnname
PropertyTypeDescription
arnstring
fullNamestring
namestring

.status.albs[].stableTargetGroup

Type
object
Required
arnname
PropertyTypeDescription
arnstring
fullNamestring
namestring

.status.blueGreen

Type
object
PropertyTypeDescription
activeSelectorstring
postPromotionAnalysisRunStatusobject
prePromotionAnalysisRunStatusobject
previewSelectorstring
scaleUpPreviewCheckPointboolean

.status.blueGreen.postPromotionAnalysisRunStatus

Type
object
Required
namestatus
PropertyTypeDescription
messagestring
namestring
statusstring

.status.blueGreen.prePromotionAnalysisRunStatus

Type
object
Required
namestatus
PropertyTypeDescription
messagestring
namestring
statusstring

.status.canary

Type
object
PropertyTypeDescription
currentBackgroundAnalysisRunStatusobject
currentExperimentstring
currentStepAnalysisRunStatusobject
stablePingPongstring
stepPluginStatusesarray
weightsobject

.status.canary.currentBackgroundAnalysisRunStatus

Type
object
Required
namestatus
PropertyTypeDescription
messagestring
namestring
statusstring

.status.canary.currentStepAnalysisRunStatus

Type
object
Required
namestatus
PropertyTypeDescription
messagestring
namestring
statusstring

.status.canary.stepPluginStatuses

Type
array

.status.canary.stepPluginStatuses[]

Type
object
Required
indexnameoperation
PropertyTypeDescription
backoffstring
disabledboolean
executionsinteger
finishedAtstring
indexinteger
messagestring
namestring
operationstring
phasestring
startedAtstring
statusobject
updatedAtstring

.status.canary.stepPluginStatuses[].status

Type
object

.status.canary.weights

Type
object
Required
canarystable
PropertyTypeDescription
additionalarray
canaryobject
stableobject
verifiedboolean

.status.canary.weights.additional

Type
array

.status.canary.weights.additional[]

Type
object
Required
weight
PropertyTypeDescription
podTemplateHashstring
serviceNamestring
weightinteger

.status.canary.weights.canary

Type
object
Required
weight
PropertyTypeDescription
podTemplateHashstring
serviceNamestring
weightinteger

.status.canary.weights.stable

Type
object
Required
weight
PropertyTypeDescription
podTemplateHashstring
serviceNamestring
weightinteger

.status.conditions

Type
array

.status.conditions[]

Type
object
Required
lastTransitionTimelastUpdateTimemessagereasonstatustype
PropertyTypeDescription
lastTransitionTimestring
lastUpdateTimestring
messagestring
reasonstring
statusstring
typestring

.status.pauseConditions

Type
array

.status.pauseConditions[]

Type
object
Required
reasonstartTime
PropertyTypeDescription
reasonstring
startTimestring

API Endpoints

The following API endpoints are available:

  • /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts
    • DELETE: delete collection of Rollout
    • GET: list objects of kind Rollout
    • POST: create a new Rollout
  • /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}
    • DELETE: delete the specified Rollout
    • GET: read the specified Rollout
    • PATCH: partially update the specified Rollout
    • PUT: replace the specified Rollout
  • /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}/status
    • GET: read status of the specified Rollout
    • PATCH: partially update status of the specified Rollout
    • PUT: replace status of the specified Rollout
  • /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}/scale
    • GET: read scale of the specified Rollout
    • PATCH: partially update scale of the specified Rollout
    • PUT: replace scale of the specified Rollout

/kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts

HTTP method
DELETE
Description
delete collection of Rollout
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind Rollout
HTTP responses
HTTP codeResponse body
200 - OKRolloutList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new Rollout
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyRollout schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKRollout schema
201 - CreatedRollout schema
202 - AcceptedRollout schema
401 - UnauthorizedEmpty

/kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}

HTTP method
DELETE
Description
delete the specified Rollout
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified Rollout
HTTP responses
HTTP codeResponse body
200 - OKRollout schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified Rollout
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKRollout schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified Rollout
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyRollout schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKRollout schema
201 - CreatedRollout schema
401 - UnauthorizedEmpty

/kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}/status

HTTP method
GET
Description
read status of the specified Rollout
HTTP responses
HTTP codeResponse body
200 - OKRollout schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified Rollout
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKRollout schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified Rollout
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyRollout schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKRollout schema
201 - CreatedRollout schema
401 - UnauthorizedEmpty

/kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}/scale

HTTP method
GET
Description
read scale of the specified Rollout
HTTP responses
HTTP codeResponse body
200 - OKScale schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update scale of the specified Rollout
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP method
PUT
Description
replace scale of the specified Rollout
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyScale schemaapplication/json formatted

API usage

The Argo Rollouts kubectl plugin operates on the namespaced Rollout custom resource. The API server path for a Rollout is:

/kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts

Use a bearer token in the Authorization header. Use application/merge-patch+json for the merge patches below and application/json-patch+json for the JSON Patch used by undo.

Command-to-API mapping

Plugin commandKubernetes API request
get rolloutGET the Rollout and list/watch its related resources.
list rolloutsGET the namespaced Rollout collection.
pausePATCH the Rollout with spec.paused=true.
resumeFor legacy clients, clear spec.paused and status.pauseConditions; see Resume a rollout. The v1.2.0 source uses promote as the registered command.
promoteGET the Rollout, then patch spec.paused, status.pauseConditions, status.currentStepIndex, or status.promoteFull according to the current rollout state.
abortPATCH the Rollout status with status.abort=true.
set imageGET the Rollout, then PUT the Rollout or its referenced workload with the changed pod-template image.
undoGET the Rollout and its controlled ReplicaSets, then JSON-patch the Rollout or its referenced workload with a previous pod template.

Replace {cluster}, {namespace}, and {name} with the target cluster, namespace, and Rollout name.

Get a rollout

get rollout builds its status tree from informers rather than issuing only one request. The initial cache population reads the following resources:

GET /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts
GET /kubernetes/{cluster}/apis/apps/v1/namespaces/{namespace}/replicasets
GET /kubernetes/{cluster}/api/v1/namespaces/{namespace}/pods
GET /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/experiments
GET /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/analysisruns

When the Rollout uses spec.workloadRef, the plugin also reads the referenced Deployment:

GET /kubernetes/{cluster}/apis/apps/v1/namespaces/{namespace}/deployments/{workloadName}

With --watch, the plugin watches these resources and refreshes the displayed tree when a related resource changes. The Rollout watch endpoint is:

GET /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts?watch=true&resourceVersion={resourceVersion}

The other related resources use their corresponding collection endpoint with watch=true and the current resourceVersion.

List rollouts

List all Rollouts in a namespace:

GET /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts

Filter by name, as the plugin does for list rollouts --name:

GET /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts?fieldSelector=metadata.name%3D{name}

List across all namespaces by omitting the namespace segment:

GET /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/rollouts

Watch the collection by adding watch=true. Start from the returned list's metadata.resourceVersion to avoid missing events:

GET /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts?watch=true&resourceVersion={resourceVersion}

Pause a rollout

pause sends a merge patch to the Rollout resource:

PATCH /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}
Content-Type: application/merge-patch+json
{
  "spec": {
    "paused": true
  }
}

Resume a rollout

The current v1.2.0 source registers promote, not a separate resume command. A legacy resume implementation used this merge patch on the main Rollout resource:

PATCH /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}
Content-Type: application/merge-patch+json
{
  "spec": {
    "paused": false
  },
  "status": {
    "pauseConditions": null
  }
}

For clusters with the Rollout status subresource enabled, send the two fields as separate requests instead:

PATCH /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}
Content-Type: application/merge-patch+json
{
  "spec": {
    "paused": false
  }
}
PATCH /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}/status
Content-Type: application/merge-patch+json
{
  "status": {
    "pauseConditions": null
  }
}

Use promote when the Rollout is paused by a canary step, a blue-green pre-promotion, or an analysis step. promote also advances the canary step when necessary.

Promote a rollout

promote first reads the Rollout:

GET /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}

The follow-up patch depends on the returned spec and status:

Rollout state or optionRequest body
spec.paused=true{"spec":{"paused":false}} on the Rollout resource.
status.pauseConditions is non-empty{"status":{"pauseConditions":null}} on /status.
A canary step must be skipped{"status":{"currentStepIndex":{nextStepIndex}}} on /status.
--full and the current pod hash is not the stable ReplicaSet{"status":{"promoteFull":true}} on /status.
An inconclusive analysis paused the rollout{"status":{"pauseConditions":null,"controllerPause":false,"currentStepIndex":{nextStepIndex}}} on /status.

For example, clear an automatic pause condition:

PATCH /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}/status
Content-Type: application/merge-patch+json
{
  "status": {
    "pauseConditions": null
  }
}

Advance a canary rollout to the next step:

PATCH /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}/status
Content-Type: application/merge-patch+json
{
  "status": {
    "pauseConditions": null,
    "currentStepIndex": 2
  }
}

Fully promote a rollout:

PATCH /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}/status
Content-Type: application/merge-patch+json
{
  "status": {
    "promoteFull": true
  }
}

A client must not blindly send every field above. Read the Rollout first and apply only the patch required by its current state. The plugin first attempts a status-subresource patch. For clusters without that subresource, it falls back to a merge patch on the main Rollout resource.

Abort a rollout

abort first tries the status subresource:

PATCH /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}/status
Content-Type: application/merge-patch+json
{
  "status": {
    "abort": true
  }
}

If the status subresource returns 404 Not Found, send the same patch to the main Rollout resource:

PATCH /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}
Content-Type: application/merge-patch+json
{
  "status": {
    "abort": true
  }
}

The Rollout controller handles the abort and reconciles the active ReplicaSet. The patch does not change spec.template; update the template separately if the new version must be fully reverted.

Set a rollout image

set image first reads the Rollout:

GET /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}

The plugin changes the matching container image in spec.template.spec.initContainers, containers, or ephemeralContainers. It then sends a full-object update, not a small patch.

For a Rollout without spec.workloadRef:

PUT /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}
Content-Type: application/json

The request body must be the complete Rollout returned by the GET request, with the selected image changed. Preserve metadata.resourceVersion and all fields not being changed. A shortened example is:

{
  "apiVersion": "argoproj.io/v1alpha1",
  "kind": "Rollout",
  "metadata": {
    "name": "demo-rollout",
    "namespace": "{namespace}",
    "resourceVersion": "{resourceVersion}"
  },
  "spec": {
    "template": {
      "spec": {
        "containers": [
          {
            "name": "demo",
            "image": "registry.example.com/demo:v2"
          }
        ]
      }
    }
  }
}

When spec.workloadRef is present, the v1.2.0 plugin treats workloadRef.name as an apps/v1 Deployment name, then reads and updates that Deployment instead:

GET /kubernetes/{cluster}/apis/apps/v1/namespaces/{namespace}/deployments/{workloadName}
PUT /kubernetes/{cluster}/apis/apps/v1/namespaces/{namespace}/deployments/{workloadName}
Content-Type: application/json

set image does not branch on workloadRef.kind in the v1.2.0 source; it always uses the Deployment endpoint shown above. On an optimistic-concurrency conflict, repeat the GET and full update. The plugin retries this sequence up to five times.

Undo a rollout

undo restores the previous revision by copying its pod template. The plugin performs these reads first:

GET /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}
GET /kubernetes/{cluster}/apis/apps/v1/namespaces/{namespace}/replicasets?labelSelector={rolloutSelector}

It considers only ReplicaSets controlled by the Rollout and selects the previous ReplicaSet by the rollout.argoproj.io/revision annotation. Use --to-revision={revision} to select an explicit revision; without it, the plugin selects the second newest revision. If the selected pod template already matches the current template, no update is sent.

The plugin removes the rollouts-pod-template-hash label from the selected pod template and sends this JSON Patch:

PATCH /kubernetes/{cluster}/apis/argoproj.io/v1alpha1/namespaces/{namespace}/rollouts/{name}
Content-Type: application/json-patch+json
[
  {
    "op": "replace",
    "path": "/spec/template",
    "value": {
      "metadata": {
        "labels": {
          "app": "demo"
        }
      },
      "spec": {
        "containers": [
          {
            "name": "demo",
            "image": "registry.example.com/demo:v1"
          }
        ]
      }
    }
  }
]

When spec.workloadRef is present, apply the same JSON Patch to the referenced object instead of the Rollout:

PATCH /kubernetes/{cluster}/apis/apps/v1/namespaces/{namespace}/deployments/{workloadName}
Content-Type: application/json-patch+json

For a ReplicaSet workload reference use /apis/apps/v1/.../replicasets/{workloadName}. For a PodTemplate workload reference use /api/v1/.../podtemplates/{workloadName}. The v1.2.0 implementation rejects unsupported workloadRef.kind values.

Permissions

The caller needs permission to read Rollouts and their related resources. Mutating operations additionally require the corresponding patch or update permission:

  • get rollout: list and watch on Rollouts, ReplicaSets, Pods, Experiments, AnalysisRuns, and referenced Deployments. A direct GET request, outside the plugin's informer flow, requires get.
  • list rollouts: list on Rollouts; add watch when watching the collection.
  • pause, resume, promote, and abort: patch on Rollouts and, when used, patch on the Rollout status subresource.
  • set image: get and update on Rollouts, or get and update on the referenced Deployment.
  • undo: get and list on Rollouts and ReplicaSets, plus patch on the Rollout or referenced workload.