Sidecar v1.3.0 custom resource definition

Select a documentation version:

Spec schema

SidecarSpec specifies the desired state of Sidecar.

  additionalVolumes 
 : 
 - 
  
 awsElasticBlockStore 
 : 
  
 fsType 
 : 
  
 string 
  
 partition 
 : 
  
 integer 
  
 readOnly 
 : 
  
 boolean 
  
 volumeID 
 : 
  
 string 
  
 azureDisk 
 : 
  
 cachingMode 
 : 
  
 string 
  
 diskName 
 : 
  
 string 
  
 diskURI 
 : 
  
 string 
  
 fsType 
 : 
  
 string 
  
 kind 
 : 
  
 string 
  
 readOnly 
 : 
  
 boolean 
  
 azureFile 
 : 
  
 readOnly 
 : 
  
 boolean 
  
 secretName 
 : 
  
 string 
  
 shareName 
 : 
  
 string 
  
 cephfs 
 : 
  
 monitors 
 : 
  
 - 
  
 string 
  
 path 
 : 
  
 string 
  
 readOnly 
 : 
  
 boolean 
  
 secretFile 
 : 
  
 string 
  
 secretRef 
 : 
  
 name 
 : 
  
 string 
  
 user 
 : 
  
 string 
  
 cinder 
 : 
  
 fsType 
 : 
  
 string 
  
 readOnly 
 : 
  
 boolean 
  
 secretRef 
 : 
  
 name 
 : 
  
 string 
  
 volumeID 
 : 
  
 string 
  
 configMap 
 : 
  
 defaultMode 
 : 
  
 integer 
  
 items 
 : 
  
 - 
  
 key 
 : 
  
 string 
  
 mode 
 : 
  
 integer 
  
 path 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 optional 
 : 
  
 boolean 
  
 csi 
 : 
  
 driver 
 : 
  
 string 
  
 fsType 
 : 
  
 string 
  
 nodePublishSecretRef 
 : 
  
 name 
 : 
  
 string 
  
 readOnly 
 : 
  
 boolean 
  
 volumeAttributes 
 : 
  
 downwardAPI 
 : 
  
 defaultMode 
 : 
  
 integer 
  
 items 
 : 
  
 - 
  
 fieldRef 
 : 
  
 apiVersion 
 : 
  
 string 
  
 fieldPath 
 : 
  
 string 
  
 mode 
 : 
  
 integer 
  
 path 
 : 
  
 string 
  
 resourceFieldRef 
 : 
  
 containerName 
 : 
  
 string 
  
 divisor 
 : 
  
 integer or string 
  
 resources 
 : 
  
 string 
  
 emptyDir 
 : 
  
 medium 
 : 
  
 string 
  
 sizeLimit 
 : 
  
 integer or string 
  
 ephemeral 
 : 
  
 volumeClaimTemplate 
 : 
  
 metadata 
 : 
  
 spec 
 : 
  
 accessModes 
 : 
  
 - 
  
 string 
  
 dataSource 
 : 
  
 apiGroup 
 : 
  
 string 
  
 kind 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 dataSourceRef 
 : 
  
 apiGroup 
 : 
  
 string 
  
 kind 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 namespace 
 : 
  
 string 
  
 resources 
 : 
  
 claims 
 : 
  
 - 
  
 name 
 : 
  
 string 
  
 limits 
 : 
  
 integer or string 
  
 requests 
 : 
  
 integer or string 
  
 selector 
 : 
  
 matchExpressions 
 : 
  
 - 
  
 key 
 : 
  
 string 
  
 operator 
 : 
  
 string 
  
 values 
 : 
  
 string 
  
 matchLabels 
 : 
  
 storageClassName 
 : 
  
 string 
  
 volumeAttributesClassName 
 : 
  
 string 
  
 volumeMode 
 : 
  
 string 
  
 volumeName 
 : 
  
 string 
  
 fc 
 : 
  
 fsType 
 : 
  
 string 
  
 lun 
 : 
  
 integer 
  
 readOnly 
 : 
  
 boolean 
  
 targetWWNs 
 : 
  
 - 
  
 string 
  
 wwids 
 : 
  
 - 
  
 string 
  
 flexVolume 
 : 
  
 driver 
 : 
  
 string 
  
 fsType 
 : 
  
 string 
  
 options 
 : 
  
 readOnly 
 : 
  
 boolean 
  
 secretRef 
 : 
  
 name 
 : 
  
 string 
  
 flocker 
 : 
  
 datasetName 
 : 
  
 string 
  
 datasetUUID 
 : 
  
 string 
  
 gcePersistentDisk 
 : 
  
 fsType 
 : 
  
 string 
  
 partition 
 : 
  
 integer 
  
 pdName 
 : 
  
 string 
  
 readOnly 
 : 
  
 boolean 
  
 gitRepo 
 : 
  
 directory 
 : 
  
 string 
  
 repository 
 : 
  
 string 
  
 revision 
 : 
  
 string 
  
 glusterfs 
 : 
  
 endpoints 
 : 
  
 string 
  
 path 
 : 
  
 string 
  
 readOnly 
 : 
  
 boolean 
  
 hostPath 
 : 
  
 path 
 : 
  
 string 
  
 type 
 : 
  
 string 
  
 iscsi 
 : 
  
 chapAuthDiscovery 
 : 
  
 boolean 
  
 chapAuthSession 
 : 
  
 boolean 
  
 fsType 
 : 
  
 string 
  
 initiatorName 
 : 
  
 string 
  
 iqn 
 : 
  
 string 
  
 iscsiInterface 
 : 
  
 string 
  
 lun 
 : 
  
 integer 
  
 portals 
 : 
  
 - 
  
 string 
  
 readOnly 
 : 
  
 boolean 
  
 secretRef 
 : 
  
 name 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 nfs 
 : 
  
 path 
 : 
  
 string 
  
 readOnly 
 : 
  
 boolean 
  
 server 
 : 
  
 string 
  
 persistentVolumeClaim 
 : 
  
 claimName 
 : 
  
 string 
  
 readOnly 
 : 
  
 boolean 
  
 photonPersistentDisk 
 : 
  
 fsType 
 : 
  
 string 
  
 pdID 
 : 
  
 string 
  
 portworxVolume 
 : 
  
 fsType 
 : 
  
 string 
  
 readOnly 
 : 
  
 boolean 
  
 volumeID 
 : 
  
 string 
  
 projected 
 : 
  
 defaultMode 
 : 
  
 integer 
  
 sources 
 : 
  
 clusterTrustBundle 
 : 
  
 labelSelector 
 : 
  
 matchExpressions 
 : 
  
 key 
 : 
  
 string 
  
 operator 
 : 
  
 string 
  
 type 
 : 
  
 string 
  
 matchLabels 
 : 
  
 object 
  
  
 namespaceSelector 
 : 
  
 matchExpressions 
 : 
  
 key 
 : 
  
 string 
  
 operator 
 : 
  
 string 
  
 values 
 : 
  
 string 
  
 matchLabels 
 : 
  
 object 
  
 name 
 : 
  
 string 
  
 optional 
 : 
  
 boolean 
  
 paht 
 : 
  
 string 
  
 signerName 
 : 
  
 string 
  
 - 
  
 configMap 
 : 
  
 items 
 : 
  
 - 
  
 key 
 : 
  
 string 
  
 mode 
 : 
  
 integer 
  
 path 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 optional 
 : 
  
 boolean 
  
 downwardAPI 
 : 
  
 items 
 : 
  
 - 
  
 fieldRef 
 : 
  
 apiVersion 
 : 
  
 string 
  
 fieldPath 
 : 
  
 string 
  
 mode 
 : 
  
 integer 
  
 path 
 : 
  
 string 
  
 resourceFieldRef 
 : 
  
 containerName 
 : 
  
 string 
  
 divisor 
 : 
  
 integer or string 
  
 resource 
 : 
  
 string 
  
 secret 
 : 
  
 items 
 : 
  
 - 
  
 key 
 : 
  
 string 
  
 mode 
 : 
  
 integer 
  
 path 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 optional 
 : 
  
 boolean 
  
 serviceAccountToken 
 : 
  
 audience 
 : 
  
 string 
  
 expirationSeconds 
 : 
  
 integer 
  
 path 
 : 
  
 string 
  
 quobyte 
 : 
  
 group 
 : 
  
 string 
  
 readOnly 
 : 
  
 boolean 
  
 registry 
 : 
  
 string 
  
 tenant 
 : 
  
 string 
  
 user 
 : 
  
 string 
  
 volume 
 : 
  
 string 
  
 rbd 
 : 
  
 fsType 
 : 
  
 string 
  
 image 
 : 
  
 string 
  
 keyring 
 : 
  
 string 
  
 monitors 
 : 
  
 - 
  
 string 
  
 pool 
 : 
  
 string 
  
 readOnly 
 : 
  
 boolean 
  
 secretRef 
 : 
  
 name 
 : 
  
 string 
  
 user 
 : 
  
 string 
  
 scaleIO 
 : 
  
 fsType 
 : 
  
 string 
  
 gateway 
 : 
  
 string 
  
 protectionDomain 
 : 
  
 string 
  
 readonly 
 : 
  
 boolean 
  
 secretRef 
 : 
  
 name 
 : 
  
 string 
  
 sslEnabled 
 : 
  
 boolean 
  
 storageMode 
 : 
  
 string 
  
 storagePool 
 : 
  
 string 
  
 system 
 : 
  
 string 
  
 volumeName 
 : 
  
 string 
  
 secret 
 : 
  
 defaultMode 
 : 
  
 integer 
  
 items 
 : 
  
 - 
  
 key 
 : 
  
 string 
  
 mode 
 : 
  
 integer 
  
 path 
 : 
  
 string 
  
 optional 
 : 
  
 boolean 
  
 secretName 
 : 
  
 string 
  
 storageos 
 : 
  
 fsType 
 : 
  
 string 
  
 readOnly 
 : 
  
 boolean 
  
 secretRef 
 : 
  
 name 
 : 
  
 string 
  
 volumeName 
 : 
  
 string 
  
 volumeNamespace 
 : 
  
 string 
  
 vsphereVolume 
 : 
  
 fsType 
 : 
  
 string 
  
 storagePolicyID 
 : 
  
 string 
  
 storagePolicyName 
 : 
  
 string 
  
 volumePath 
 : 
  
 string 
 sidecars 
 : 
 - 
  
 args 
 : 
  
 - 
  
 string 
  
 command 
 : 
  
 - 
  
 string 
  
 env 
 : 
  
 - 
  
 name 
 : 
  
 string 
  
 value 
 : 
  
 string 
  
 valueFrom 
 : 
  
 configMapKeyRef 
 : 
  
 key 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 optional 
 : 
  
 boolean 
  
 fieldRef 
 : 
  
 apiVersion 
 : 
  
 string 
  
 fieldPath 
 : 
  
 string 
  
 resourceFieldRef 
 : 
  
 containerName 
 : 
  
 string 
  
 divisor 
 : 
  
 integer or string 
  
 resource 
 : 
  
 string 
  
 secretKeyRef 
 : 
  
 key 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 optional 
 : 
  
 boolean 
  
 envFrom 
 : 
  
 - 
  
 configMapRef 
 : 
  
 name 
 : 
  
 string 
  
 optional 
 : 
  
 boolean 
  
 prefix 
 : 
  
 string 
  
 secretRef 
 : 
  
 name 
 : 
  
 string 
  
 optional 
 : 
  
 boolean 
  
 image 
 : 
  
 string 
  
 imagePullPolicy 
 : 
  
 string 
  
 lifecycle 
 : 
  
 postStart 
 : 
  
 exec 
 : 
  
 command 
 : 
  
 - 
  
 string 
  
 httpGet 
 : 
  
 host 
 : 
  
 string 
  
 httpHeaders 
 : 
  
 - 
  
 name 
 : 
  
 string 
  
 value 
 : 
  
 string 
  
 path 
 : 
  
 string 
  
 port 
 : 
  
 integer or string 
  
 scheme 
 : 
  
 string 
  
 sleep 
 : 
  
 seconds 
 : 
  
 integer64 
  
 tcpSocket 
 : 
  
 host 
 : 
  
 string 
  
 port 
 : 
  
 integer or string 
  
 preStop 
 : 
  
 exec 
 : 
  
 command 
 : 
  
 - 
  
 string 
  
 httpGet 
 : 
  
 host 
 : 
  
 string 
  
 httpHeaders 
 : 
  
 - 
  
 name 
 : 
  
 string 
  
 value 
 : 
  
 string 
  
 path 
 : 
  
 string 
  
 port 
 : 
  
 integer or string 
  
 scheme 
 : 
  
 string 
  
 sleep 
 : 
  
 seconds 
 : 
  
 integer64 
  
 tcpSocket 
 : 
  
 host 
 : 
  
 string 
  
 port 
 : 
  
 integer or string 
  
 livenessProbe 
 : 
  
 exec 
 : 
  
 command 
 : 
  
 - 
  
 string 
  
 failureThreshold 
 : 
  
 integer 
  
 grpc 
 : 
  
 port 
 : 
  
 integer 
  
 service 
 : 
  
 string 
  
 httpGet 
 : 
  
 host 
 : 
  
 string 
  
 httpHeaders 
 : 
  
 - 
  
 name 
 : 
  
 string 
  
 value 
 : 
  
 string 
  
 path 
 : 
  
 string 
  
 port 
 : 
  
 integer or string 
  
 scheme 
 : 
  
 string 
  
 initialDelaySeconds 
 : 
  
 integer 
  
 periodSeconds 
 : 
  
 integer 
  
 successThreshold 
 : 
  
 integer 
  
 tcpSocket 
 : 
  
 host 
 : 
  
 string 
  
 port 
 : 
  
 integer or string 
  
 terminationGracePeriodSeconds 
 : 
  
 integer 
  
 timeoutSeconds 
 : 
  
 integer 
  
 name 
 : 
  
 string 
  
 ports 
 : 
  
 - 
  
 containerPort 
 : 
  
 integer 
  
 hostIP 
 : 
  
 string 
  
 hostPort 
 : 
  
 integer 
  
 name 
 : 
  
 string 
  
 protocol 
 : 
  
 string 
  
 readinessProbe 
 : 
  
 exec 
 : 
  
 command 
 : 
  
 - 
  
 string 
  
 failureThreshold 
 : 
  
 integer 
  
 grpc 
 : 
  
 port 
 : 
  
 integer 
  
 service 
 : 
  
 string 
  
 httpGet 
 : 
  
 host 
 : 
  
 string 
  
 httpHeaders 
 : 
  
 - 
  
 name 
 : 
  
 string 
  
 value 
 : 
  
 string 
  
 path 
 : 
  
 string 
  
 port 
 : 
  
 integer or string 
  
 scheme 
 : 
  
 string 
  
 initialDelaySeconds 
 : 
  
 integer 
  
 periodSeconds 
 : 
  
 integer 
  
 successThreshold 
 : 
  
 integer 
  
 tcpSocket 
 : 
  
 host 
 : 
  
 string 
  
 port 
 : 
  
 integer or string 
  
 terminationGracePeriodSeconds 
 : 
  
 integer 
  
 timeoutSeconds 
 : 
  
 integer 
  
 resizePolicy 
 : 
  
 - 
  
 resourceName 
 : 
  
 string 
  
 restartPolicy 
 : 
  
 string 
  
 resources 
 : 
  
 claims 
 : 
  
 - 
  
 name 
 : 
  
 string 
  
 limits 
 : 
  
 integer or string 
  
 requests 
 : 
  
 integer or string 
  
 restartPolicy 
 : 
  
 string 
  
 securityContext 
 : 
  
 allowPrivilegeEscalation 
 : 
  
 boolean 
  
 capabilities 
 : 
  
 add 
 : 
  
 - 
  
 string 
  
 drop 
 : 
  
 - 
  
 string 
  
 privileged 
 : 
  
 boolean 
  
 procMount 
 : 
  
 string 
  
 readOnlyRootFilesystem 
 : 
  
 boolean 
  
 runAsGroup 
 : 
  
 integer 
  
 runAsNonRoot 
 : 
  
 boolean 
  
 runAsUser 
 : 
  
 integer 
  
 seLinuxOptions 
 : 
  
 level 
 : 
  
 string 
  
 role 
 : 
  
 string 
  
 type 
 : 
  
 string 
  
 user 
 : 
  
 string 
  
 seccompProfile 
 : 
  
 localhostProfile 
 : 
  
 string 
  
 type 
 : 
  
 string 
  
 windowsOptions 
 : 
  
 gmsaCredentialSpec 
 : 
  
 string 
  
 gmsaCredentialSpecName 
 : 
  
 string 
  
 hostProcess 
 : 
  
 boolean 
  
 runAsUserName 
 : 
  
 string 
  
 startupProbe 
 : 
  
 exec 
 : 
  
 command 
 : 
  
 - 
  
 string 
  
 failureThreshold 
 : 
  
 integer 
  
 grpc 
 : 
  
 port 
 : 
  
 integer 
  
 service 
 : 
  
 string 
  
 httpGet 
 : 
  
 host 
 : 
  
 string 
  
 httpHeaders 
 : 
  
 - 
  
 name 
 : 
  
 string 
  
 value 
 : 
  
 string 
  
 path 
 : 
  
 string 
  
 port 
 : 
  
 integer or string 
  
 scheme 
 : 
  
 string 
  
 initialDelaySeconds 
 : 
  
 integer 
  
 periodSeconds 
 : 
  
 integer 
  
 successThreshold 
 : 
  
 integer 
  
 tcpSocket 
 : 
  
 host 
 : 
  
 string 
  
 port 
 : 
  
 integer or string 
  
 terminationGracePeriodSeconds 
 : 
  
 integer 
  
 timeoutSeconds 
 : 
  
 integer 
  
 stdin 
 : 
  
 boolean 
  
 stdinOnce 
 : 
  
 boolean 
  
 terminationMessagePath 
 : 
  
 string 
  
 terminationMessagePolicy 
 : 
  
 string 
  
 tty 
 : 
  
 boolean 
  
 volumeDevices 
 : 
  
 - 
  
 devicePath 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 volumeMounts 
 : 
  
 - 
  
 mountPath 
 : 
  
 string 
  
 mountPropagation 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 readOnly 
 : 
  
 boolean 
  
 subPath 
 : 
  
 string 
  
 subPathExpr 
 : 
  
 string 
  
 workingDir 
 : 
  
 string

Field

Type
Required or optional

Description

additionalVolumes

list (object)
Optional

AdditionalVolumes specifies a list of existing volumes to mount into the sidecar containers. Refer to https://kubernetes.io/docs/concepts/storage/volumes/ for more information.

additionalVolumes[]

object
Optional

Volume represents a named volume in a pod that may be accessed by any container in the pod.

additionalVolumes[].awsElasticBlockStore

object
Optional

awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

additionalVolumes[].awsElasticBlockStore.fsType

string
Optional

fsType is the file system type of the volume that you want to mount. Tip: Ensure that the file system type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

additionalVolumes[].awsElasticBlockStore.partition

integer
Optional

partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).

additionalVolumes[].awsElasticBlockStore.readOnly

boolean
Optional

readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

additionalVolumes[].awsElasticBlockStore.volumeID

string
Required

volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

additionalVolumes[].azureDisk

object
Optional

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

additionalVolumes[].azureDisk.cachingMode

string
Optional

cachingMode is the Host Caching mode: None, Read-only, Read Write.

additionalVolumes[].azureDisk.diskName

string
Required

diskName is the Name of the data disk in the blob storage

additionalVolumes[].azureDisk.diskURI

string
Required

diskURI is the URI of data disk in the blob storage

additionalVolumes[].azureDisk.fsType

string
Optional

fsType is File system type to mount. Must be a file system type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

additionalVolumes[].azureDisk.kind

string
Optional

kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared

additionalVolumes[].azureDisk.readOnly

boolean
Optional

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

additionalVolumes[].azureFile

object
Optional

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

additionalVolumes[].azureFile.readOnly

boolean
Optional

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

additionalVolumes[].azureFile.secretName

string
Required

secretName is the name of secret that contains Azure Storage Account Name and Key

additionalVolumes[].azureFile.shareName

string
Required

shareName is the azure share Name

additionalVolumes[].cephfs

object
Optional

cephFS represents a Ceph FS mount on the host that shares a pod's lifetime

additionalVolumes[].cephfs.monitors

list (string)
Required

monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

additionalVolumes[].cephfs.path

string
Optional

path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /

additionalVolumes[].cephfs.readOnly

boolean
Optional

readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

additionalVolumes[].cephfs.secretFile

string
Optional

secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

additionalVolumes[].cephfs.secretRef

object
Optional

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

additionalVolumes[].cephfs.secretRef.name

string
Optional

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

additionalVolumes[].cephfs.user

string
Optional

user is optional: User is the rados username, default is administrator More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

additionalVolumes[].cinder

object
Optional

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

additionalVolumes[].cinder.fsType

string
Optional

fsType is the file system type to mount. Must be a file system type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

additionalVolumes[].cinder.readOnly

boolean
Optional

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

additionalVolumes[].cinder.secretRef

object
Optional

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack

additionalVolumes[].cinder.secretRef.name

string
Optional

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

additionalVolumes[].cinder.volumeID

string
Required

volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

additionalVolumes[].configMap

object
Optional

configMap represents a configMap that should populate this volume

additionalVolumes[].configMap.defaultMode

integer
Optional

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

additionalVolumes[].configMap.items

list (object)
Optional

items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys won't be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

additionalVolumes[].configMap.items[]

object
Optional

Maps a string key to a path within a volume.

additionalVolumes[].configMap.items[].key

string
Required

key is the key to project.

additionalVolumes[].configMap.items[].mode

integer
Optional

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

additionalVolumes[].configMap.items[].path

string
Required

path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

additionalVolumes[].csi

object
Optional

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

additionalVolumes[].csi.driver

string
Required

driver is the name of the CSI driver that handles this volume. Consult with your administrator for the correct name as registered in the cluster.

additionalVolumes[].csi.fsType

string
Optional

fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default file system to apply.

additionalVolumes[].csi.nodePublishSecretRef

object
optional

nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

additionalVolumes[].csi.nodePublishSecretRef.name

string
Optional

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

additionalVolumes[].csi.readOnly

boolean
Optional

readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).

additionalVolumes[].csi.volumeAttributes

object (string)
Optional

volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.

additionalVolumes[].downwardAPI

object
Optional

downwardAPI represents downward API about the pod that should populate this volume

additionalVolumes[].downwardAPI.defaultMode

integer
Optional

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

additionalVolumes[].downwardAPI.items

list (object)
Optional

Items is a list of downward API volume file

additionalVolumes[].downwardAPI.items[]

object
Optional

DownwardAPIVolumeFile represents information to create the file containing the pod field

additionalVolumes[].downwardAPI.items[].fieldRef

object
Optional

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

additionalVolumes[].downwardAPI.items[].fieldRef.apiVersion

string
Optional

Version of the schema the FieldPath is written in terms of, defaults to "v1".

additionalVolumes[].downwardAPI.items[].fieldRef.fieldPath

string
Required

Path of the field to select in the specified API version.

additionalVolumes[].downwardAPI.items[].mode

integer
Optional

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

additionalVolumes[].downwardAPI.items[].path

string
Required

Required: Path is the relative path of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'.

additionalVolumes[].downwardAPI.items[].resourceFieldRef

object
Optional

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are supported.

additionalVolumes[].downwardAPI.items[].resourceFieldRef.containerName

string
Optional

Container name: required for volumes, optional for env vars

additionalVolumes[].downwardAPI.items[].resourceFieldRef.divisor

integer or string
Optional

Specifies the output format of the exposed resources, defaults to "1"

additionalVolumes[].downwardAPI.items[].resourceFieldRef.resource

string
Required

Required: resource to select

additionalVolumes[].emptyDir

object
Optional

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

additionalVolumes[].emptyDir.medium

string
Optional

medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

additionalVolumes[].emptyDir.sizeLimit

integer or string
Optional

sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

additionalVolumes[].ephemeral

object
Optional

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. \n Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). \n Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. \n Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. \n A pod can use both types of ephemeral volumes and persistent volumes at the same time.

additionalVolumes[].ephemeral.volumeClaimTemplate

object
Optional

Will be used to create a standalone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, or the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where

<volume
    name>

is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). \n An existing PVC with that name that is not owned by the pod won't* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this isn't necessary, but it may be useful when manually reconstructing a broken cluster. \n This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. \n Required, must not be nil.

additionalVolumes[].ephemeral.volumeClaimTemplate.metadata

object
Optional

May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec

object
Required

The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.accessModes

list (string)
Optional

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.accessModes[]

string
Optional

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.dataSource

object
Optional

dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef won't be copied to dataSource.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.dataSource.apiGroup

string
Optional

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.dataSource.kind

string
Required

Kind is the type of resource being referenced

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.dataSource.name

string
Required

Name is the name of resource being referenced

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef

object
Optional

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef.apiGroup

string
Optional

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef.kind

string
Required

Kind is the type of resource being referenced

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef.name

string
Required

Name is the name of resource being referenced

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef.namespace

string
Optional

Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.resources

object
Optional

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.resources.claims

list (object)
Optional

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. \n This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. \n This field is immutable. It can only be set for containers.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.resources.claims[]

object
Optional

ResourceClaim references one entry in PodSpec.ResourceClaims.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.resources.claims[].name

string
Required

Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.resources.limits

integer or string
Optional

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.resources.requests

integer or string
Optional

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.selector

object
Optional

selector is a label query over volumes to consider for binding.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

list (object)
Optional

matchExpressions is a list of label selector requirements. The requirements are ANDed.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[]

object
Optional

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

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[].key

string
Required

key is the label key that the selector applies to.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[].operator

string
Required

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

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[].values

string
Optional

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.selector.matchLabels

object
Optional

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.storageClassName

string
Optional

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.volumeAttributesClassName

string
Optional

volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: Persistent Volumes - VolumeAttributesClass (Alpha) . Using this field requires the VolumeAttributesClass feature gate to be enabled.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.volumeMode

string
Optional

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

additionalVolumes[].ephemeral.volumeClaimTemplate.spec.volumeName

string
Optional

volumeName is the binding reference to the PersistentVolume backing this claim.

additionalVolumes[].fc

object
Optional

fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

additionalVolumes[].fc.fsType

string
Optional

fsType is the file system type to mount. Must be a file system type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

additionalVolumes[].fc.lun

integer
Optional

lun is Optional: FC target lun number

additionalVolumes[].fc.readOnly

boolean
Optional

readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

additionalVolumes[].fc.targetWWNs

list (string)
Optional

targetWWNs is Optional: FC target worldwide names (WWNs)

additionalVolumes[].fc.targetWWNs[]

string
Optional

additionalVolumes[].fc.wwids

list (string)
Optional

wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

additionalVolumes[].fc.wwids[]

string
Optional

additionalVolumes[].flexVolume

object
Optional

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

additionalVolumes[].flexVolume.driver

string
Required

driver is the name of the driver to use for this volume.

additionalVolumes[].flexVolume.fsType

string
Optional

fsType is the file system type to mount. Must be a file system type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default file system depends on FlexVolume script.

additionalVolumes[].flexVolume.options

object
Optional

options is Optional: this field holds extra command options if any.

additionalVolumes[].flexVolume.readOnly

boolean
Optional

readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

additionalVolumes[].flexVolume.secretRef

object
Optional

secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

additionalVolumes[].flexVolume.secretRef.name

string
Optional

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

additionalVolumes[].flocker

object
Optional

flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running

additionalVolumes[].flocker.datasetName

string
Optional

datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated

additionalVolumes[].flocker.datasetUUID

string
Optional

datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset

additionalVolumes[].gcePersistentDisk

object
Optional

gcePersistentDisk represents a Compute Engine Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

additionalVolumes[].gcePersistentDisk.fsType

string
Optional

fsType is file system type of the volume that you want to mount. Tip: Ensure that the file system type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

additionalVolumes[].gcePersistentDisk.partition

integer
Optional

additionalVolumes[].gcePersistentDisk.pdName

string
Required

pdName is unique name of the persistent disk resource in Compute Engine. Used to identify the disk in Compute Engine. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

additionalVolumes[].gcePersistentDisk.readOnly

boolean
Optional

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

additionalVolumes[].gitRepo

object
Optional

gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repository, mount an EmptyDir into an InitContainer that clones the repository using git, then mount the EmptyDir into the Pod's container.

additionalVolumes[].gitRepo.directory

string
Optional

directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

additionalVolumes[].gitRepo.repository

string
Required

repository is the URL

additionalVolumes[].gitRepo.revision

string
Optional

revision is the commit hash for the specified revision.

additionalVolumes[].glusterfs

object
Optional

glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

additionalVolumes[].glusterfs.endpoints

string
Required

endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

additionalVolumes[].glusterfs.path

string
Required

path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

additionalVolumes[].glusterfs.readOnly

boolean
Optional

readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

additionalVolumes[].hostPath

object
Optional

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

additionalVolumes[].hostPath.path

string
Required

path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

additionalVolumes[].hostPath.type

string
Optional

type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

additionalVolumes[].iscsi

object
Optional

iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

additionalVolumes[].iscsi.chapAuthDiscovery

boolean
Optional

chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication

additionalVolumes[].iscsi.chapAuthSession

boolean
Optional

chapAuthSession defines whether support iSCSI Session CHAP authentication

additionalVolumes[].iscsi.fsType

string
Optional

additionalVolumes[].iscsi.initiatorName

string
Optional

initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.

additionalVolumes[].iscsi.iqn

string
Required

iqn is the target iSCSI Qualified Name.

additionalVolumes[].iscsi.iscsiInterface

string
Optional

iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).

additionalVolumes[].iscsi.lun

integer
Required

lun represents iSCSI Target Lun number.

additionalVolumes[].iscsi.portals

list (string)
Optional

portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

additionalVolumes[].iscsi.portals[]

string
Optional

additionalVolumes[].iscsi.readOnly

boolean
Optional

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

additionalVolumes[].iscsi.secretRef

object
Optional

secretRef is the CHAP Secret for iSCSI target and initiator authentication

additionalVolumes[].iscsi.secretRef.name

string
Optional

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

additionalVolumes[].iscsi.targetPortal

string
Required

targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

additionalVolumes[].name

string
Required

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

additionalVolumes[].nfs

object
Optional

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

additionalVolumes[].nfs.path

string
Required

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

additionalVolumes[].nfs.readOnly

boolean
Optional

readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

additionalVolumes[].nfs.server

string
Required

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

additionalVolumes[].persistentVolumeClaim

object
Optional

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

additionalVolumes[].persistentVolumeClaim.claimName

string
Required

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

additionalVolumes[].persistentVolumeClaim.readOnly

boolean
Optional

readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

additionalVolumes[].photonPersistentDisk

object
Optional

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

additionalVolumes[].photonPersistentDisk.fsType

string
Optional

fsType is the file system type to mount. Must be a file system type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

additionalVolumes[].photonPersistentDisk.pdID

string
Required

pdID is the ID that identifies Photon Controller persistent disk

additionalVolumes[].portworxVolume

object
Optional

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

additionalVolumes[].portworxVolume.fsType

string
Optional

fSType represents the file system type to mount Must be a file system type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.

additionalVolumes[].portworxVolume.readOnly

boolean
Optional

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

additionalVolumes[].portworxVolume.volumeID

string
Required

volumeID uniquely identifies a Portworx volume

additionalVolumes[].projected

object
Optional

projected items for all in one resources secrets, configmaps, and downward API

additionalVolumes[].projected.defaultMode

integer
Optional

defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

additionalVolumes[].projected.sources

list (object)
Optional

sources is the list of volume projections

additionalVolumes[].projected.sources[]

object
Optional

Projection that may be projected along with other supported volume types.

additionalVolumes[].projected.sources[].clusterTrustBundle

object
Optional

ClusterTrustBundle allows a pod to access the .spec.trustBundle field of ClusterTrustBundle objects in an auto-updating file.
Alpha, gated by the ClusterTrustBundleProjection feature gate.
ClusterTrustBundle objects can either be selected by name, or by the combination of signer name and a label selector.
Kubelet performs aggressive normalization of the PEM contents written into the pod file system. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.

additionalVolumes[].projected.sources[].clusterTrustBundle.labelSelector

object
Optional

Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as "match nothing". If set but empty, interpreted as "match everything".

additionalVolumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions

object
Optional

matchExpressions is a list of label selector requirements. The requirements are ANDed.

additionalVolumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions.key

string
Required

key is the label key that the selector applies to.

additionalVolumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions.operator

string
Required

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

additionalVolumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions.values

string
Optional

additionalVolumes[].projected.sources[].clusterTrustBundle.labelSelector.matchLabels

object
Optional

additionalVolumes[].projected.sources[].configMap

object
Optional

configMap information about the configMap data to project

additionalVolumes[].projected.sources[].configMap.items

list (object)
Optional

additionalVolumes[].projected.sources[].configMap.items[]

object
Optional

Maps a string key to a path within a volume.

additionalVolumes[].projected.sources[].configMap.items[].key

string
Required

key is the key to project.

additionalVolumes[].projected.sources[].configMap.items[].mode

integer
Optional

additionalVolumes[].projected.sources[].configMap.items[].path

string
Required

path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

additionalVolumes[].projected.sources[].configMap.name

string
Optional

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

additionalVolumes[].projected.sources[].configMap.optional

boolean
Optional

optional specify whether the ConfigMap or its keys must be defined

additionalVolumes[].projected.sources[].downwardAPI

object
Optional

downwardAPI information about the downwardAPI data to project

additionalVolumes[].projected.sources[].downwardAPI.items

list (object)
Optional

Items is a list of DownwardAPIVolume file

additionalVolumes[].projected.sources[].downwardAPI.items[]

object
Optional

DownwardAPIVolumeFile represents information to create the file containing the pod field

additionalVolumes[].projected.sources[].downwardAPI.items[].fieldRef

object
Optional

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

additionalVolumes[].projected.sources[].downwardAPI.items[].fieldRef.apiVersion

string
Optional

Version of the schema the FieldPath is written in terms of, defaults to "v1".

additionalVolumes[].projected.sources[].downwardAPI.items[].fieldRef.fieldPath

string
Required

Path of the field to select in the specified API version.

additionalVolumes[].projected.sources[].downwardAPI.items[].mode

integer
Optional

additionalVolumes[].projected.sources[].downwardAPI.items[].path

string
Required

Required: Path is the relative path of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

additionalVolumes[].projected.sources[].downwardAPI.items[].resourceFieldRef

object
Optional

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are supported.

additionalVolumes[].projected.sources[].downwardAPI.items[].resourceFieldRef.containerName

string
Optional

Container name: required for volumes, optional for env vars

additionalVolumes[].projected.sources[].downwardAPI.items[].resourceFieldRef.divisor

integer or string
Optional

Specifies the output format of the exposed resources, defaults to "1"

additionalVolumes[].projected.sources[].downwardAPI.items[].resourceFieldRef.resource

string
Required

Required: resource to select

additionalVolumes[].projected.sources[].secret

object
Optional

secret information about the secret data to project

additionalVolumes[].projected.sources[].secret.items

list (object)
Optional

items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys won't be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

additionalVolumes[].projected.sources[].secret.items[]

object
Optional

Maps a string key to a path within a volume.

additionalVolumes[].projected.sources[].secret.items[].key

string
Required

key is the key to project.

additionalVolumes[].projected.sources[].secret.items[].mode

integer
Optional

additionalVolumes[].projected.sources[].secret.items[].path

string
Required

path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

additionalVolumes[].projected.sources[].secret.name

string
Optional

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

additionalVolumes[].projected.sources[].secret.optional

boolean
Optional

optional field specify whether the Secret or its key must be defined

additionalVolumes[].projected.sources[].serviceAccountToken

object
Optional

serviceAccountToken is information about the serviceAccountToken data to project

additionalVolumes[].projected.sources[].serviceAccountToken.audience

string
Optional

audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.

additionalVolumes[].projected.sources[].serviceAccountToken.expirationSeconds

integer
Optional

expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.

additionalVolumes[].projected.sources[].serviceAccountToken.path

string
Required

path is the path relative to the mount point of the file to project the token into.

additionalVolumes[].quobyte

object
Optional

quobyte represents a Quobyte mount on the host that shares a pod's lifetime

additionalVolumes[].quobyte.group

string
Optional

group to map volume access to Default is no group

additionalVolumes[].quobyte.readOnly

boolean
Optional

readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

additionalVolumes[].quobyte.registry

string
Required

registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

additionalVolumes[].quobyte.tenant

string
Optional

tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin

additionalVolumes[].quobyte.user

string
Optional

user to map volume access to Defaults to serivceaccount user

additionalVolumes[].quobyte.volume

string
Required

volume is a string that references an already created Quobyte volume by name.

additionalVolumes[].rbd

object
Optional

rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

additionalVolumes[].rbd.fsType

string
Optional

additionalVolumes[].rbd.image

string
Required

image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

additionalVolumes[].rbd.keyring

string
Optional

keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

additionalVolumes[].rbd.monitors

list (string)
Required

monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

additionalVolumes[].rbd.monitors[]

string
Optional

additionalVolumes[].rbd.pool

string
Optional

pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

additionalVolumes[].rbd.readOnly

boolean
Optional

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

additionalVolumes[].rbd.secretRef

object
Optional

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

additionalVolumes[].rbd.secretRef.name

string
Optional

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

additionalVolumes[].rbd.user

string
Optional

user is the rados username. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

additionalVolumes[].scaleIO

object
Optional

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

additionalVolumes[].scaleIO.fsType

string
Optional

fsType is the file system type to mount. Must be a file system type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".

additionalVolumes[].scaleIO.gateway

string
Required

gateway is the host address of the ScaleIO API Gateway.

additionalVolumes[].scaleIO.protectionDomain

string
Optional

protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.

additionalVolumes[].scaleIO.readOnly

boolean
Optional

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

additionalVolumes[].scaleIO.secretRef

object
Required

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

additionalVolumes[].scaleIO.secretRef.name

string
Optional

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

additionalVolumes[].scaleIO.sslEnabled

boolean
Optional

sslEnabled Flag enable/disable SSL communication with Gateway, default false

additionalVolumes[].scaleIO.storageMode

string
Optional

storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.

additionalVolumes[].scaleIO.storagePool

string
Optional

storagePool is the ScaleIO Storage Pool associated with the protection domain.

additionalVolumes[].scaleIO.system

string
Required

system is the name of the storage system as configured in ScaleIO.

additionalVolumes[].scaleIO.volumeName

TYPE
Optional

volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.

additionalVolumes[].secret

object
Optional

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

additionalVolumes[].secret.defaultMode

integer
Optional

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

additionalVolumes[].secret.items

list (object)
Optional

items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys won't be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.

additionalVolumes[].secret.items[]

object
Optional

Maps a string key to a path within a volume.

additionalVolumes[].secret.items[].key

string
Required

key is the key to project.

additionalVolumes[].secret.items[].mode

integer
Optional

additionalVolumes[].secret.items[].path

string
Required

path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

additionalVolumes[].secret.optional

boolean
Optional

optional field specify whether the Secret or its keys must be defined

additionalVolumes[].secret.secretName

string
Optional

secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

additionalVolumes[].storageos

object
Optional

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

additionalVolumes[].storageos.fsType

string
Optional

fsType is the file system type to mount. Must be a file system type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

additionalVolumes[].storageos.readOnly

boolean
Optional

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

additionalVolumes[].storageos.secretRef

object
Optional

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

additionalVolumes[].storageos.secretRef.name

string
Optional

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

additionalVolumes[].storageos.volumeName

string
Optional

volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.

additionalVolumes[].storageos.volumeNamespace

string
Optional

volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that don't pre-exist within StorageOS will be created.

additionalVolumes[].vsphereVolume

object
Optional

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

additionalVolumes[].vsphereVolume.fsType

string
Optional

fsType is file system type to mount. Must be a file system type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

additionalVolumes[].vsphereVolume.storagePolicyID

string
Optional

storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

additionalVolumes[].vsphereVolume.storagePolicyName

string
Optional

storagePolicyName is the storage Policy Based Management (SPBM) profile name.

additionalVolumes[].vsphereVolume.volumePath

string
Required

volumePath is the path that identifies vSphere volume vmdk

sidecars

list (object)
Optional

Sidecar specifies a list of sidecar containers to inject into the database pod. Refer to https://kubernetes.io/docs/concepts/containers/ for more information.

sidecars[]

object
Optional

A single application container that you want to run within a pod.

sidecars[].args

list (string)
Optional

Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax:; on other words, "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references are never expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

sidecars[].args[]

string
Optional

sidecars[].command

list (string)
Optional

Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax; in other words, "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

sidecars[].command[]

string
Optional

sidecars[].env

list (object)
Optional

List of environment variables to set in the container. Cannot be updated.

sidecars[].env[]

object
Optional

EnvVar represents an environment variable present in a Container.

sidecars[].env[].name

string
Required

Name of the environment variable. Must be a C_IDENTIFIER.

sidecars[].env[].value

string
Optional

Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax; in other words, "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

sidecars[].env[].valueFrom

object
Optional

Source for the environment variable's value. Cannot be used if value is not empty.

sidecars[].env[].valueFrom.configMapKeyRef

object
Optional

Selects a key of a ConfigMap.

sidecars[].env[].valueFrom.configMapKeyRef.key

string
Required

The key to select.

sidecars[].env[].valueFrom.configMapKeyRef.name

string
Optional

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

sidecars[].env[].valueFrom.configMapKeyRef.optional

boolean
Optional

Specify whether the ConfigMap or its key must be defined

sidecars[].env[].valueFrom.fieldRef

object
Optional

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

sidecars[].env[].valueFrom.fieldRef.apiVersion

string
Optional

Version of the schema the FieldPath is written in terms of, defaults to "v1".

sidecars[].env[].valueFrom.fieldRef.fieldPath

string
Required

Path of the field to select in the specified API version.

sidecars[].env[].valueFrom.resourceFieldRef

object
Optional

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are supported.

sidecars[].env[].valueFrom.resourceFieldRef.containerName

string
Optional

Container name: required for volumes, optional for env vars

sidecars[].env[].valueFrom.resourceFieldRef.divisor

integer or string
Optional

Specifies the output format of the exposed resources, defaults to "1"

sidecars[].env[].valueFrom.resourceFieldRef.resource

string
Required

Required: resource to select

sidecars[].env[].valueFrom.secretKeyRef

object
Optional

Selects a key of a secret in the pod's namespace

sidecars[].env[].valueFrom.secretKeyRef.key

string
Required

The key of the secret to select from. Must be a valid secret key.

sidecars[].env[].valueFrom.secretKeyRef.name

string
Optional

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

sidecars[].env[].valueFrom.secretKeyRef.optional

boolean
Optional

Specify whether the Secret or its key must be defined

sidecars[].envFrom

list (object)
Optional

List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

sidecars[].envFrom[]

object
Optional

EnvFromSource represents the source of a set of ConfigMaps

sidecars[].envFrom[].configMapRef

object
Optional

The ConfigMap to select from

sidecars[].envFrom[].configMapRef.name

string
Optional

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

sidecars[].envFrom[].configMapRef.optional

boolean
Optional

Specify whether the ConfigMap must be defined

sidecars[].envFrom[].prefix

string
Optional

An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

sidecars[].envFrom[].secretRef

object
Optional

The Secret to select from

sidecars[].envFrom[].secretRef.name

string
Optional

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

sidecars[].envFrom[].secretRef.optional

boolean
Optional

Specify whether the Secret must be defined

sidecars[].image

string
Optional

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

sidecars[].imagePullPolicy

string
Optional

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :{{ .Chart.Version }} tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

sidecars[].lifecycle

object
Optional

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

sidecars[].lifecycle.postStart

object
Optional

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

sidecars[].lifecycle.postStart.exec

object
Optional

Exec specifies the action to take.

sidecars[].lifecycle.postStart.exec.command

list (string)
Optional

Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's file system. The command is exec'd, it is not run inside a shell, so standard shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

sidecars[].lifecycle.postStart.exec.command[]

string
Optional

sidecars[].lifecycle.postStart.httpGet

object
Optional

HTTPGet specifies the http request to perform.

sidecars[].lifecycle.postStart.httpGet.host

string
Optional

Hostname to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

sidecars[].lifecycle.postStart.httpGet.httpHeaders

list (object)
Optional

Custom headers to set in the request. HTTP allows repeated headers.

sidecars[].lifecycle.postStart.httpGet.httpHeaders[]

object
Optional

HTTPHeader describes a custom header to be used in HTTP probes

sidecars[].lifecycle.postStart.httpGet.httpHeaders[].name

string
Required

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

sidecars[].lifecycle.postStart.httpGet.httpHeaders[].value

string
Required

The header field value

sidecars[].lifecycle.postStart.httpGet.path

string
Optional

Path to access on the HTTP server.

sidecars[].lifecycle.postStart.httpGet.port

integer or string
Required

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

sidecars[].lifecycle.postStart.httpGet.scheme

string
Optional

Scheme to use for connecting to the host. Defaults to HTTP.

sidecars[].lifecycle.postStart.sleep

object
Optional

Sleep represents the duration that the container must sleep before being terminated.

sidecars[].lifecycle.postStart.sleep.seconds

object
Required

Seconds is the number of seconds to sleep in int64 format.

sidecars[].lifecycle.postStart.tcpSocket

object
Optional

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.

sidecars[].lifecycle.postStart.tcpSocket.host

string
Optional

Optional: Hostname to connect to, defaults to the pod IP.

sidecars[].lifecycle.postStart.tcpSocket.port

integer or string
Required

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

sidecars[].lifecycle.preStop

object
Optional

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, and resource contention. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

sidecars[].lifecycle.preStop.exec

object
Optional

Exec specifies the action to take.

sidecars[].lifecycle.preStop.exec.command

list (string)
Optional

Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's file system. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

sidecars[].lifecycle.preStop.exec.command[]

string
Optional

sidecars[].lifecycle.preStop.httpGet

object
Optional

HTTPGet specifies the http request to perform.

sidecars[].lifecycle.preStop.httpGet.host

string
Optional

Hostname to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

sidecars[].lifecycle.preStop.httpGet.httpHeaders

list (object)
Optional

Custom headers to set in the request. HTTP allows repeated headers.

sidecars[].lifecycle.preStop.httpGet.httpHeaders[]

object
Optional

HTTPHeader describes a custom header to be used in HTTP probes

sidecars[].lifecycle.preStop.httpGet.httpHeaders[].name

string
Required

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

sidecars[].lifecycle.preStop.httpGet.httpHeaders[].value

string
Required

The header field value

sidecars[].lifecycle.preStop.httpGet.path

string
Optional

Path to access on the HTTP server.

sidecars[].lifecycle.preStop.httpGet.port

integer or string
Required

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

sidecars[].lifecycle.preStop.httpGet.scheme

string
Optional

Scheme to use for connecting to the host. Defaults to HTTP.

sidecars[].lifecycle.preStop.sleep

object
Optional

Sleep represents the duration that the container should sleep before being terminated.

sidecars[].lifecycle.preStop.sleep.seconds

object
Required

Seconds is the number of seconds to sleep in int64 format.

sidecars[].lifecycle.preStop.tcpSocket

object
Optional

sidecars[].lifecycle.preStop.tcpSocket.host

string
Optional

Optional: Hostname to connect to, defaults to the pod IP.

sidecars[].lifecycle.preStop.tcpSocket.port

integer or string
Required

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

sidecars[].livenessProbe

object
Optional

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

sidecars[].livenessProbe.exec

object
Optional

Exec specifies the action to take.

sidecars[].livenessProbe.exec.command

list (string)
Optional

sidecars[].livenessProbe.exec.command[]

string
Optional

sidecars[].livenessProbe.failureThreshold

integer
Optional

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

sidecars[].livenessProbe.grpc

object
Optional

GRPC specifies an action involving a GRPC port.

sidecars[].livenessProbe.grpc.port

integer
Required

Port number of the gRPC service. Number must be in the range 1 to 65535.

sidecars[].livenessProbe.grpc.service

string
Optional

Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC.

sidecars[].livenessProbe.httpGet

object
Optional

HTTPGet specifies the http request to perform.

sidecars[].livenessProbe.httpGet.host

string
Optional

Hostname to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

sidecars[].livenessProbe.httpGet.httpHeaders

list (object)
Optional

Custom headers to set in the request. HTTP allows repeated headers.

sidecars[].livenessProbe.httpGet.httpHeaders[]

object
Optional

HTTPHeader describes a custom header to be used in HTTP probes

sidecars[].livenessProbe.httpGet.httpHeaders[].name

string
Required

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

sidecars[].livenessProbe.httpGet.httpHeaders[].value

string
Required

The header field value

sidecars[].livenessProbe.httpGet.path

string
Optional

Path to access on the HTTP server.

sidecars[].livenessProbe.httpGet.port

integer or string
Required

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

sidecars[].livenessProbe.httpGet.scheme

string
Optional

Scheme to use for connecting to the host. Defaults to HTTP.

sidecars[].livenessProbe.initialDelaySeconds

integer
Optional

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

sidecars[].livenessProbe.periodSeconds

integer
Optional

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

sidecars[].livenessProbe.successThreshold

integer
Optional

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

sidecars[].livenessProbe.tcpSocket

object
Optional

TCPSocket specifies an action involving a TCP port.

sidecars[].livenessProbe.tcpSocket.host

string
Optional

Optional: Hostname to connect to, defaults to the pod IP.

sidecars[].livenessProbe.tcpSocket.port

integer or string
Required

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

sidecars[].livenessProbe.terminationGracePeriodSeconds

integer
Optional

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately using the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

sidecars[].livenessProbe.timeoutSeconds

integer
Optional

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

sidecars[].name

string
Required

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

sidecars[].ports

list (object)
Optional

List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.

sidecars[].ports[]

object
Optional

ContainerPort represents a network port in a single container.

sidecars[].ports[].containerPort

integer
Required

Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.

sidecars[].ports[].hostIP

string
Optional

What host IP to bind the external port to.

sidecars[].ports[].hostPort

integer
Optional

Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers don't need this.

sidecars[].ports[].name

string
Optional

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

sidecars[].ports[].protocol

string
Optional

Default value: TCP

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

sidecars[].readinessProbe

object
Optional

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

sidecars[].readinessProbe.exec

object
Optional

Exec specifies the action to take.

sidecars[].readinessProbe.exec.command

list (string)
Optional

Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's file system. The command is is exec'd, it is not run inside a shell, so standard shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

sidecars[].readinessProbe.exec.command[]

string
Optional

sidecars[].readinessProbe.failureThreshold

integer
Optional

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

sidecars[].readinessProbe.grpc

object
Optional

GRPC specifies an action involving a GRPC port.

sidecars[].readinessProbe.grpc.port

integer
Required

Port number of the gRPC service. Number must be in the range 1 to 65535.

sidecars[].readinessProbe.grpc.service

string
Optional

sidecars[].readinessProbe.httpGet

object
Optional

HTTPGet specifies the http request to perform.

sidecars[].readinessProbe.httpGet.host

string
Optional

Hostname to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

sidecars[].readinessProbe.httpGet.httpHeaders

list (object)
Optional

Custom headers to set in the request. HTTP allows repeated headers.

sidecars[].readinessProbe.httpGet.httpHeaders[]

object
Optional

HTTPHeader describes a custom header to be used in HTTP probes

sidecars[].readinessProbe.httpGet.httpHeaders[].name

string
Required

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

sidecars[].readinessProbe.httpGet.httpHeaders[].value

string
Required

The header field value

sidecars[].readinessProbe.httpGet.path

string
Optional

Path to access on the HTTP server.

sidecars[].readinessProbe.httpGet.port

integer or string
Required

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

sidecars[].readinessProbe.httpGet.scheme

string
Optional

Scheme to use for connecting to the host. Defaults to HTTP.

sidecars[].readinessProbe.initialDelaySeconds

integer
Optional

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

sidecars[].readinessProbe.periodSeconds

integer
Optional

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

sidecars[].readinessProbe.successThreshold

integer
Optional

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

sidecars[].readinessProbe.tcpSocket

object
Optional

TCPSocket specifies an action involving a TCP port.

sidecars[].readinessProbe.tcpSocket.host

string
Optional

Optional: Hostname to connect to, defaults to the pod IP.

sidecars[].readinessProbe.tcpSocket.port

integer or string
Required

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

sidecars[].readinessProbe.terminationGracePeriodSeconds

integer
Optional

sidecars[].readinessProbe.timeoutSeconds

integer
Optional

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

sidecars[].resizePolicy

list (object)
Optional

Resources resize policy for the container.

sidecars[].resizePolicy[]

object
Optional

ContainerResizePolicy represents resource resize policy for the container.

sidecars[].resizePolicy[].resourceName

string
Required

Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.

sidecars[].resizePolicy[].restartPolicy

string
Required

Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.

sidecars[].resources

object
Optional

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

sidecars[].resources.claims

list (object)
Optional

sidecars[].resources.claims[]

object
Optional

ResourceClaim references one entry in PodSpec.ResourceClaims.

sidecars[].resources.claims[].name

string
Required

Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

sidecars[].resources.limits

integer or string
Optional

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

sidecars[].resources.requests

integer or string
Optional

sidecars[].restartPolicy

string
Optional

RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.

sidecars[].securityContext

object
Optional

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

sidecars[].securityContext.allowPrivilegeEscalation

boolean
Optional

AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.

sidecars[].securityContext.capabilities

object
Optional

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

sidecars[].securityContext.capabilities.add

list (string)
Optional

Added capabilities

sidecars[].securityContext.capabilities.add[]

string
Optional

Capability represent POSIX capabilities type

sidecars[].securityContext.capabilities.drop

list (string)
Optional

Removed capabilities

sidecars[].securityContext.capabilities.drop[]

string
Optional

Capability represent POSIX capabilities type

sidecars[].securityContext.privileged

boolean
Optional

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.

sidecars[].securityContext.procMount

string
Optional

procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.

sidecars[].securityContext.readOnlyRootFilesystem

boolean
Optional

Whether this container has a read-only root file system. Default is false. Note that this field cannot be set when spec.os.name is windows.

sidecars[].securityContext.runAsGroup

integer
Optional

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

sidecars[].securityContext.runAsNonRoot

boolean
Optional

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

sidecars[].securityContext.runAsUser

integer
Optional

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

sidecars[].securityContext.seLinuxOptions

object
Optional

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

sidecars[].securityContext.seLinuxOptions.level

string
Optional

Level is SELinux level label that applies to the container.

sidecars[].securityContext.seLinuxOptions.role

string
Optional

Role is a SELinux role label that applies to the container.

sidecars[].securityContext.seLinuxOptions.type

string
Optional

Type is a SELinux type label that applies to the container.

sidecars[].securityContext.seLinuxOptions.user

string
Optional

User is a SELinux user label that applies to the container.

sidecars[].securityContext.seccompProfile

object
Optional

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.

sidecars[].securityContext.seccompProfile.localhostProfile

string
Optional

localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type.

sidecars[].securityContext.seccompProfile.type

string
Required

type indicates which kind of seccomp profile will be applied. Valid options are: \n Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

sidecars[].securityContext.windowsOptions

object
Optional

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

sidecars[].securityContext.windowsOptions.gmsaCredentialSpec

string
Optional

GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

sidecars[].securityContext.windowsOptions.gmsaCredentialSpecName

string
Optional

GMSACredentialSpecName is the name of the GMSA credential spec to use.

sidecars[].securityContext.windowsOptions.hostProcess

boolean
Optional

HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.

sidecars[].securityContext.windowsOptions.runAsUserName

string
Optional

The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

sidecars[].startupProbe

object
Optional

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

sidecars[].startupProbe.exec

object
Optional

Exec specifies the action to take.

sidecars[].startupProbe.exec.command

list (string)
Optional

sidecars[].startupProbe.exec.command[]

string
Optional

sidecars[].startupProbe.failureThreshold

integer
Optional

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

sidecars[].startupProbe.grpc

object
Optional

GRPC specifies an action involving a GRPC port.

sidecars[].startupProbe.grpc.port

integer
Required

Port number of the gRPC service. Number must be in the range 1 to 65535.

sidecars[].startupProbe.grpc.service

string
Optional

sidecars[].startupProbe.httpGet

object
Optional

HTTPGet specifies the http request to perform.

sidecars[].startupProbe.httpGet.host

string
Optional

Hostname to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

sidecars[].startupProbe.httpGet.httpHeaders

list (object)
Optional

Custom headers to set in the request. HTTP allows repeated headers.

sidecars[].startupProbe.httpGet.httpHeaders[]

object
Optional

HTTPHeader describes a custom header to be used in HTTP probes

sidecars[].startupProbe.httpGet.httpHeaders[].name

string
Required

The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

sidecars[].startupProbe.httpGet.httpHeaders[].value

string
Required

The header field value

sidecars[].startupProbe.httpGet.path

string
Optional

Path to access on the HTTP server.

sidecars[].startupProbe.httpGet.port

integer or string
Required

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

sidecars[].startupProbe.httpGet.scheme

string
Optional

Scheme to use for connecting to the host. Defaults to HTTP.

sidecars[].startupProbe.initialDelaySeconds

integer
Optional

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

sidecars[].startupProbe.periodSeconds

integer
Optional

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

sidecars[].startupProbe.successThreshold

integer
Optional

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

sidecars[].startupProbe.tcpSocket

object
Optional

TCPSocket specifies an action involving a TCP port.

sidecars[].startupProbe.tcpSocket.host

string
Optional

Optional: Hostname to connect to, defaults to the pod IP.

sidecars[].startupProbe.tcpSocket.port

integer or string
Required

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

sidecars[].startupProbe.terminationGracePeriodSeconds

integer
Optional

sidecars[].startupProbe.timeoutSeconds

integer
Optional

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

sidecars[].stdin

boolean
Optional

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

sidecars[].stdinOnce

boolean
Optional

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

sidecars[].terminationMessagePath

string
Optional

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's file system. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

sidecars[].terminationMessagePolicy

string
Optional

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

sidecars[].tty

boolean
Optional

Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.

sidecars[].volumeDevices

list (object)
Optional

volumeDevices is the list of block devices to be used by the container.

sidecars[].volumeDevices[]

object
Optional

volumeDevice describes a mapping of a raw block device within a container.

sidecars[].volumeDevices[].devicePath

string
Required

devicePath is the path inside of the container that the device will be mapped to.

sidecars[].volumeDevices[].name

string
Required

name must match the name of a persistentVolumeClaim in the pod

sidecars[].volumeMounts

list (object)
Optional

Pod volumes to mount into the container's file system. Cannot be updated.

sidecars[].volumeMounts[]

object
Optional

VolumeMount describes a mounting of a Volume within a container.

sidecars[].volumeMounts[].mountPath

string
Required

Path within the container at which the volume should be mounted. Must not contain ':'.

sidecars[].volumeMounts[].mountPropagation

string
Optional

mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

sidecars[].volumeMounts[].name

string
Required

This must match the Name of a Volume.

sidecars[].volumeMounts[].readOnly

boolean
Optional

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

sidecars[].volumeMounts[].subPath

string
Optional

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

sidecars[].volumeMounts[].subPathExpr

string
Optional

Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

sidecars[].workingDir

string
Optional

Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

Status schema

SidecarStatus specifies the observed state of Sidecar.

  conditions 
 : 
 - 
  
 lastTransitionTime 
 : 
  
 string 
  
 message 
 : 
  
 string 
  
 observedGeneration 
 : 
  
 integer 
  
 reason 
 : 
  
 string 
  
 status 
 : 
  
 string 
  
 type 
 : 
  
 string 
 criticalIncidents 
 : 
 - 
  
 code 
 : 
  
 string 
  
 createTime 
 : 
  
 string 
  
 message 
 : 
  
 string 
  
 messageTemplateParams 
 : 
  
 resource 
 : 
  
 component 
 : 
  
 string 
  
 location 
 : 
  
 cluster 
 : 
  
 string 
  
 group 
 : 
  
 string 
  
 kind 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 namespace 
 : 
  
 string 
  
 version 
 : 
  
 string 
  
 stackTrace 
 : 
  
 - 
  
 component 
 : 
  
 string 
  
 message 
 : 
  
 string 
  
 transientUntil 
 : 
  
 string 
 observedGeneration 
 : 
  
 integer 
 reconciled 
 : 
  
 boolean

Field

Type
Required or optional

Description

conditions

list (object)
Optional

Conditions represents the latest available observations of the Entity's current state.

conditions[]

object
Optional

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }

conditions[].lastTransitionTime

string
Required

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

conditions[].message

string
Required

Maximum length: 32768

message is a human readable message indicating details about the transition. This may be an empty string.

conditions[].observedGeneration

integer
Optional

observedGeneration represents the .metadata.generation that the condition was set based upon. For example, if .metadata.generation is 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

conditions[].reason

string
Required

Minimum length: 1; Maximum length: 1024

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

conditions[].status

string
Required

Valid values: "True" , "False" , Unknown

status of the condition, one of True, False, Unknown.

conditions[].type

string
Required

Maximum length: 316

type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regular expression it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

criticalIncidents

list (object)
Optional

CriticalIncidents is a flat list of all active Critical Incidents.

criticalIncidents[]

object
Optional

CriticalIncident contains all information about an ongoing critical incident.

criticalIncidents[].code

string
Required

Code is the error code of this particular error. Error codes are DBSE+numeric strings, like "DBSE1012".

criticalIncidents[].createTime

string
Required

CreateTime is the timestamp when this Incident was created at the origin.

criticalIncidents[].message

string
Optional

Message describes the incident/error that occurred.

criticalIncidents[].messageTemplateParams

object
Optional

MessageTemplateParams contains key-value pairs necessary for generating a user-friendly data-driven version of Message in the UI.

criticalIncidents[].resource

object
Required

Resource contains information about the Database Service component that reported the incident as well as about the Kubernetes resource.

criticalIncidents[].resource.component

string
Required

Component is an internal identifier of the Database Service subsystem that reported the incident.

criticalIncidents[].resource.location

object
Optional

Location

criticalIncidents[].resource.location.cluster

string
Optional

Cluster is the name of the cluster of the affected Kubernetes resource.

criticalIncidents[].resource.location.group

string
Optional

Group is the Group name of the Kubernetes resource.

criticalIncidents[].resource.location.kind

string
Optional

Kind is the Kind of the Kubernetes resource.

criticalIncidents[].resource.location.name

string
Optional

Name is the name of the affected Kubernetes resource.

criticalIncidents[].resource.location.namespace

string
Optional

Namespace is the namespace of the affected Kubernetes resource.

criticalIncidents[].resource.location.version

string
Optional

Version is the Version of the Kubernetes resource.

criticalIncidents[].stackTrace

list (object)
Optional

StackTrace contains an unstructured list of messages from the stack trace.

criticalIncidents[].stackTrace[]

object
Optional

CriticalIncidentStackTraceMessage contains stack trace information available for the incident.

criticalIncidents[].stackTrace[].component

string
Optional

Component is the name of a Database Service component that logged the message.

criticalIncidents[].stackTrace[].message

string
Optional

Logged message.

criticalIncidents[].transientUntil

string
Optional

TransientUntil if present indicates that the issue should be considered transient until the specified time.

observedGeneration

integer
Optional

Internal: The generation observed by the controller.

reconciled

boolean
Optional

Internal: Whether the resource was reconciled by the controller.

Sidecar v1.3.0 custom resource definition Stay organized with collections Save and categorize content based on your preferences.

Spec schema

Status schema

Sidecar v1.3.0 custom resource definition