PostgreSQLs
- Description
- Postgresql defines a PostgreSQL cluster managed by the Zalando Postgres Operator. It allows configuring various aspects of PostgreSQL including replication, backups, resource allocation, and more. Postgresql defines the desired state and status of a PostgreSQL cluster managed by the Zalando Postgres Operator.
- Type
object- Required
spec
Specification
.spec
- Description
- Spec defines the desired state of the PostgreSQL cluster including configuration, resources, replication settings, and more.
- Type
object- Required
numberOfInstancespostgresqlteamId
.spec.additionalVolumes
- Description
- AdditionalVolumes defines additional volumes for the pod
- Type
array
.spec.additionalVolumes[]
- Description
- AdditionalVolume defines additional volumes that can be mounted to PostgreSQL pods
- Type
object- Required
mountPathnametargetContainersvolumeSource
.spec.additionalVolumes[].targetContainers
- Description
- List of container names that should mount this volume
- Type
array
.spec.additionalVolumes[].targetContainers[]
- Type
string
.spec.additionalVolumes[].volumeSource
- Description
- Kubernetes VolumeSource defining the volume type and configuration
- Type
object
.spec.additionalVolumes[].volumeSource.awsElasticBlockStore
- Description
- 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
- Type
object- Required
volumeID
.spec.additionalVolumes[].volumeSource.azureDisk
- Description
- azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
- Type
object- Required
diskNamediskURI
.spec.additionalVolumes[].volumeSource.azureFile
- Description
- azureFile represents an Azure File Service mount on the host and bind mount to the pod.
- Type
object- Required
secretNameshareName
.spec.additionalVolumes[].volumeSource.cephfs
- Description
- cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
- Type
object- Required
monitors
.spec.additionalVolumes[].volumeSource.cephfs.monitors
- Description
- monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- Type
array
.spec.additionalVolumes[].volumeSource.cephfs.monitors[]
- Type
string
.spec.additionalVolumes[].volumeSource.cephfs.secretRef
- Description
- 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
- Type
object
.spec.additionalVolumes[].volumeSource.cinder
- Description
- cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- Type
object- Required
volumeID
.spec.additionalVolumes[].volumeSource.cinder.secretRef
- Description
- secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.
- Type
object
.spec.additionalVolumes[].volumeSource.configMap
- Description
- configMap represents a configMap that should populate this volume
- Type
object
.spec.additionalVolumes[].volumeSource.configMap.items
- Description
- 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 will not 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 '..'.
- Type
array
.spec.additionalVolumes[].volumeSource.configMap.items[]
- Description
- Maps a string key to a path within a volume.
- Type
object- Required
keypath
.spec.additionalVolumes[].volumeSource.csi
- Description
- csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
- Type
object- Required
driver
.spec.additionalVolumes[].volumeSource.csi.nodePublishSecretRef
- Description
- 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.
- Type
object
.spec.additionalVolumes[].volumeSource.csi.volumeAttributes
- Description
- volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
- Type
object
.spec.additionalVolumes[].volumeSource.downwardAPI
- Description
- downwardAPI represents downward API about the pod that should populate this volume
- Type
object
.spec.additionalVolumes[].volumeSource.downwardAPI.items
- Description
- Items is a list of downward API volume file
- Type
array
.spec.additionalVolumes[].volumeSource.downwardAPI.items[]
- Description
- DownwardAPIVolumeFile represents information to create the file containing the pod field
- Type
object- Required
path
.spec.additionalVolumes[].volumeSource.downwardAPI.items[].fieldRef
- Description
- Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
- Type
object- Required
fieldPath
.spec.additionalVolumes[].volumeSource.downwardAPI.items[].resourceFieldRef
- Description
- Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- Type
object- Required
resource
.spec.additionalVolumes[].volumeSource.emptyDir
- Description
- emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- Type
object
.spec.additionalVolumes[].volumeSource.ephemeral
- Description
- 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. 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). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. 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. A pod can use both types of ephemeral volumes and persistent volumes at the same time.
- Type
object
.spec.additionalVolumes[].volumeSource.ephemeral.volumeClaimTemplate
- Description
- Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. 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). An existing PVC with that name that is not owned by the pod will *not* 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 should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.
- Type
object- Required
spec
.spec.additionalVolumes[].volumeSource.ephemeral.volumeClaimTemplate.spec
- Description
- 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.
- Type
object
.spec.additionalVolumes[].volumeSource.ephemeral.volumeClaimTemplate.spec.accessModes
- Description
- accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
- Type
array
.spec.additionalVolumes[].volumeSource.ephemeral.volumeClaimTemplate.spec.accessModes[]
- Type
string
.spec.additionalVolumes[].volumeSource.ephemeral.volumeClaimTemplate.spec.dataSource
- Description
- 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 will not be copied to dataSource.
- Type
object- Required
kindname
.spec.additionalVolumes[].volumeSource.ephemeral.volumeClaimTemplate.spec.dataSourceRef
- Description
- 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.
- Type
object- Required
kindname
.spec.additionalVolumes[].volumeSource.ephemeral.volumeClaimTemplate.spec.resources
- Description
- 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
- Type
object
.spec.additionalVolumes[].volumeSource.ephemeral.volumeClaimTemplate.spec.resources.limits
- Description
- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
object
.spec.additionalVolumes[].volumeSource.ephemeral.volumeClaimTemplate.spec.resources.requests
- Description
- 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/
- Type
object
.spec.additionalVolumes[].volumeSource.ephemeral.volumeClaimTemplate.spec.selector
- Description
- selector is a label query over volumes to consider for binding.
- Type
object
.spec.additionalVolumes[].volumeSource.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.additionalVolumes[].volumeSource.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.additionalVolumes[].volumeSource.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[].values
- Description
- 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.
- Type
array
.spec.additionalVolumes[].volumeSource.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[].values[]
- Type
string
.spec.additionalVolumes[].volumeSource.ephemeral.volumeClaimTemplate.spec.selector.matchLabels
- Description
- 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.
- Type
object
.spec.additionalVolumes[].volumeSource.fc
- Description
- fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
- Type
object
.spec.additionalVolumes[].volumeSource.fc.targetWWNs
- Description
- targetWWNs is Optional: FC target worldwide names (WWNs)
- Type
array
.spec.additionalVolumes[].volumeSource.fc.targetWWNs[]
- Type
string
.spec.additionalVolumes[].volumeSource.fc.wwids
- Description
- wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
- Type
array
.spec.additionalVolumes[].volumeSource.fc.wwids[]
- Type
string
.spec.additionalVolumes[].volumeSource.flexVolume
- Description
- flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
- Type
object- Required
driver
.spec.additionalVolumes[].volumeSource.flexVolume.options
- Description
- options is Optional: this field holds extra command options if any.
- Type
object
.spec.additionalVolumes[].volumeSource.flexVolume.secretRef
- Description
- 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.
- Type
object
.spec.additionalVolumes[].volumeSource.flocker
- Description
- flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
- Type
object
.spec.additionalVolumes[].volumeSource.gcePersistentDisk
- Description
- gcePersistentDisk represents a GCE 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
- Type
object- Required
pdName
.spec.additionalVolumes[].volumeSource.gitRepo
- Description
- gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
- Type
object- Required
repository
.spec.additionalVolumes[].volumeSource.glusterfs
- Description
- glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md
- Type
object- Required
endpointspath
.spec.additionalVolumes[].volumeSource.hostPath
- Description
- 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 --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.
- Type
object- Required
path
.spec.additionalVolumes[].volumeSource.iscsi
- Description
- 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
- Type
object- Required
iqnluntargetPortal
.spec.additionalVolumes[].volumeSource.iscsi.portals
- Description
- 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).
- Type
array
.spec.additionalVolumes[].volumeSource.iscsi.portals[]
- Type
string
.spec.additionalVolumes[].volumeSource.iscsi.secretRef
- Description
- secretRef is the CHAP Secret for iSCSI target and initiator authentication
- Type
object
.spec.additionalVolumes[].volumeSource.nfs
- Description
- nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- Type
object- Required
pathserver
.spec.additionalVolumes[].volumeSource.persistentVolumeClaim
- Description
- persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- Type
object- Required
claimName
.spec.additionalVolumes[].volumeSource.photonPersistentDisk
- Description
- photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
- Type
object- Required
pdID
.spec.additionalVolumes[].volumeSource.portworxVolume
- Description
- portworxVolume represents a portworx volume attached and mounted on kubelets host machine
- Type
object- Required
volumeID
.spec.additionalVolumes[].volumeSource.projected
- Description
- projected items for all in one resources secrets, configmaps, and downward API
- Type
object
.spec.additionalVolumes[].volumeSource.projected.sources
- Description
- sources is the list of volume projections
- Type
array
.spec.additionalVolumes[].volumeSource.projected.sources[]
- Description
- Projection that may be projected along with other supported volume types
- Type
object
.spec.additionalVolumes[].volumeSource.projected.sources[].clusterTrustBundle
- Description
- 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 filesystem. 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.
- Type
object- Required
path
.spec.additionalVolumes[].volumeSource.projected.sources[].clusterTrustBundle.labelSelector
- Description
- 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".
- Type
object
.spec.additionalVolumes[].volumeSource.projected.sources[].clusterTrustBundle.labelSelector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.additionalVolumes[].volumeSource.projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.additionalVolumes[].volumeSource.projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[].values
- Description
- 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.
- Type
array
.spec.additionalVolumes[].volumeSource.projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[].values[]
- Type
string
.spec.additionalVolumes[].volumeSource.projected.sources[].clusterTrustBundle.labelSelector.matchLabels
- Description
- 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.
- Type
object
.spec.additionalVolumes[].volumeSource.projected.sources[].configMap
- Description
- configMap information about the configMap data to project
- Type
object
.spec.additionalVolumes[].volumeSource.projected.sources[].configMap.items
- Description
- 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 will not 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 '..'.
- Type
array
.spec.additionalVolumes[].volumeSource.projected.sources[].configMap.items[]
- Description
- Maps a string key to a path within a volume.
- Type
object- Required
keypath
.spec.additionalVolumes[].volumeSource.projected.sources[].downwardAPI
- Description
- downwardAPI information about the downwardAPI data to project
- Type
object
.spec.additionalVolumes[].volumeSource.projected.sources[].downwardAPI.items
- Description
- Items is a list of DownwardAPIVolume file
- Type
array
.spec.additionalVolumes[].volumeSource.projected.sources[].downwardAPI.items[]
- Description
- DownwardAPIVolumeFile represents information to create the file containing the pod field
- Type
object- Required
path
.spec.additionalVolumes[].volumeSource.projected.sources[].downwardAPI.items[].fieldRef
- Description
- Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
- Type
object- Required
fieldPath
.spec.additionalVolumes[].volumeSource.projected.sources[].downwardAPI.items[].resourceFieldRef
- Description
- Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- Type
object- Required
resource
.spec.additionalVolumes[].volumeSource.projected.sources[].secret
- Description
- secret information about the secret data to project
- Type
object
.spec.additionalVolumes[].volumeSource.projected.sources[].secret.items
- Description
- 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 will not 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 '..'.
- Type
array
.spec.additionalVolumes[].volumeSource.projected.sources[].secret.items[]
- Description
- Maps a string key to a path within a volume.
- Type
object- Required
keypath
.spec.additionalVolumes[].volumeSource.projected.sources[].serviceAccountToken
- Description
- serviceAccountToken is information about the serviceAccountToken data to project
- Type
object- Required
path
.spec.additionalVolumes[].volumeSource.quobyte
- Description
- quobyte represents a Quobyte mount on the host that shares a pod's lifetime
- Type
object- Required
registryvolume
.spec.additionalVolumes[].volumeSource.rbd
- Description
- 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
- Type
object- Required
imagemonitors
.spec.additionalVolumes[].volumeSource.rbd.monitors
- Description
- monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- Type
array
.spec.additionalVolumes[].volumeSource.rbd.monitors[]
- Type
string
.spec.additionalVolumes[].volumeSource.rbd.secretRef
- Description
- 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
- Type
object
.spec.additionalVolumes[].volumeSource.scaleIO
- Description
- scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
- Type
object- Required
gatewaysecretRefsystem
.spec.additionalVolumes[].volumeSource.scaleIO.secretRef
- Description
- secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
- Type
object
.spec.additionalVolumes[].volumeSource.secret
- Description
- secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
- Type
object
.spec.additionalVolumes[].volumeSource.secret.items
- Description
- 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 will not 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 '..'.
- Type
array
.spec.additionalVolumes[].volumeSource.secret.items[]
- Description
- Maps a string key to a path within a volume.
- Type
object- Required
keypath
.spec.additionalVolumes[].volumeSource.storageos
- Description
- storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
- Type
object
.spec.additionalVolumes[].volumeSource.storageos.secretRef
- Description
- secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
- Type
object
.spec.additionalVolumes[].volumeSource.vsphereVolume
- Description
- vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
- Type
object- Required
volumePath
.spec.allowedSourceRanges
- Description
- AllowedSourceRanges specifies IP ranges allowed to access load balancers
- Type
array
.spec.allowedSourceRanges[]
- Type
string
.spec.backup
- Description
- Backup defines backup configuration
- Type
object- Required
storage
.spec.backup.resources
- Description
- Resources describes requests and limits for the Backup sidecar resouces.
- Type
object
.spec.backup.resources.limits
- Description
- ResourceLimits defines the maximum resources allowed for containers
- Type
object
.spec.backup.resources.requests
- Description
- ResourceRequests defines the minimum resources required for containers
- Type
object
.spec.backup.storage
- Description
- storage defines the configuration for backup storage including the storage name, namespace, and bucket location.
- Type
object- Required
bucketnamenamespace
.spec.clone
- Description
- Clone defines configuration for cloning from another cluster
- Type
object
.spec.clusterReplication
- Description
- ClusterReplication defines cross-cluster replication
- Type
object
.spec.connectionPooler
- Description
- ConnectionPooler configuration for connection pooling
- Type
object
.spec.connectionPooler.resources
- Description
- Resources defines CPU and memory requirements for the connection pooler containers. If not specified, uses operator defaults.
- Type
object
.spec.connectionPooler.resources.limits
- Description
- ResourceLimits defines the maximum resources allowed for containers
- Type
object
.spec.connectionPooler.resources.requests
- Description
- ResourceRequests defines the minimum resources required for containers
- Type
object
.spec.databases
- Description
- Databases defines databases to be created in the cluster
- Type
object
.spec.env
- Description
- Env defines environment variables for containers
- Type
array
.spec.env[]
- Description
- EnvVar represents an environment variable present in a Container.
- Type
object- Required
name
.spec.env[].valueFrom
- Description
- Source for the environment variable's value. Cannot be used if value is not empty.
- Type
object
.spec.env[].valueFrom.configMapKeyRef
- Description
- Selects a key of a ConfigMap.
- Type
object- Required
key
.spec.env[].valueFrom.fieldRef
- Description
- 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.
- Type
object- Required
fieldPath
.spec.env[].valueFrom.resourceFieldRef
- Description
- 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 currently supported.
- Type
object- Required
resource
.spec.env[].valueFrom.secretKeyRef
- Description
- Selects a key of a secret in the pod's namespace
- Type
object- Required
key
.spec.exporter
- Description
- Exporter defines Prometheus exporter configuration
- Type
object
.spec.exporter.env
- Type
array
.spec.exporter.env[]
- Description
- EnvVar represents an environment variable present in a Container.
- Type
object- Required
name
.spec.exporter.env[].valueFrom
- Description
- Source for the environment variable's value. Cannot be used if value is not empty.
- Type
object
.spec.exporter.env[].valueFrom.configMapKeyRef
- Description
- Selects a key of a ConfigMap.
- Type
object- Required
key
.spec.exporter.env[].valueFrom.fieldRef
- Description
- 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.
- Type
object- Required
fieldPath
.spec.exporter.env[].valueFrom.resourceFieldRef
- Description
- 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 currently supported.
- Type
object- Required
resource
.spec.exporter.env[].valueFrom.secretKeyRef
- Description
- Selects a key of a secret in the pod's namespace
- Type
object- Required
key
.spec.init_containers
- Description
- InitContainersOld is a deprecated field for init containers
- Type
array
.spec.init_containers[]
- Description
- A single application container that you want to run within a pod.
- Type
object- Required
name
.spec.init_containers[].args
- Description
- 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: i.e. "$$(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
- Type
array
.spec.init_containers[].args[]
- Type
string
.spec.init_containers[].command
- Description
- 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: i.e. "$$(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
- Type
array
.spec.init_containers[].command[]
- Type
string
.spec.init_containers[].env
- Description
- List of environment variables to set in the container. Cannot be updated.
- Type
array
.spec.init_containers[].env[]
- Description
- EnvVar represents an environment variable present in a Container.
- Type
object- Required
name
.spec.init_containers[].env[].valueFrom
- Description
- Source for the environment variable's value. Cannot be used if value is not empty.
- Type
object
.spec.init_containers[].env[].valueFrom.configMapKeyRef
- Description
- Selects a key of a ConfigMap.
- Type
object- Required
key
.spec.init_containers[].env[].valueFrom.fieldRef
- Description
- 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.
- Type
object- Required
fieldPath
.spec.init_containers[].env[].valueFrom.resourceFieldRef
- Description
- 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 currently supported.
- Type
object- Required
resource
.spec.init_containers[].env[].valueFrom.secretKeyRef
- Description
- Selects a key of a secret in the pod's namespace
- Type
object- Required
key
.spec.init_containers[].envFrom
- Description
- 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.
- Type
array
.spec.init_containers[].envFrom[]
- Description
- EnvFromSource represents the source of a set of ConfigMaps
- Type
object
.spec.init_containers[].envFrom[].configMapRef
- Description
- The ConfigMap to select from
- Type
object
.spec.init_containers[].envFrom[].secretRef
- Description
- The Secret to select from
- Type
object
.spec.init_containers[].lifecycle
- Description
- Actions that the management system should take in response to container lifecycle events. Cannot be updated.
- Type
object
.spec.init_containers[].lifecycle.postStart
- Description
- 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
- Type
object
.spec.init_containers[].lifecycle.postStart.exec
- Description
- Exec specifies the action to take.
- Type
object
.spec.init_containers[].lifecycle.postStart.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. 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.
- Type
array
.spec.init_containers[].lifecycle.postStart.exec.command[]
- Type
string
.spec.init_containers[].lifecycle.postStart.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.init_containers[].lifecycle.postStart.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.init_containers[].lifecycle.postStart.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.spec.init_containers[].lifecycle.postStart.sleep
- Description
- Sleep represents the duration that the container should sleep before being terminated.
- Type
object- Required
seconds
.spec.init_containers[].lifecycle.postStart.tcpSocket
- Description
- 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.
- Type
object- Required
port
.spec.init_containers[].lifecycle.preStop
- Description
- PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. 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
- Type
object
.spec.init_containers[].lifecycle.preStop.exec
- Description
- Exec specifies the action to take.
- Type
object
.spec.init_containers[].lifecycle.preStop.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. 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.
- Type
array
.spec.init_containers[].lifecycle.preStop.exec.command[]
- Type
string
.spec.init_containers[].lifecycle.preStop.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.init_containers[].lifecycle.preStop.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.init_containers[].lifecycle.preStop.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.spec.init_containers[].lifecycle.preStop.sleep
- Description
- Sleep represents the duration that the container should sleep before being terminated.
- Type
object- Required
seconds
.spec.init_containers[].lifecycle.preStop.tcpSocket
- Description
- 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.
- Type
object- Required
port
.spec.init_containers[].livenessProbe
- Description
- 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
- Type
object
.spec.init_containers[].livenessProbe.exec
- Description
- Exec specifies the action to take.
- Type
object
.spec.init_containers[].livenessProbe.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. 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.
- Type
array
.spec.init_containers[].livenessProbe.exec.command[]
- Type
string
.spec.init_containers[].livenessProbe.grpc
- Description
- GRPC specifies an action involving a GRPC port.
- Type
object- Required
port
.spec.init_containers[].livenessProbe.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.init_containers[].livenessProbe.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.init_containers[].livenessProbe.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.spec.init_containers[].livenessProbe.tcpSocket
- Description
- TCPSocket specifies an action involving a TCP port.
- Type
object- Required
port
.spec.init_containers[].ports
- Description
- 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.
- Type
array
.spec.init_containers[].ports[]
- Description
- ContainerPort represents a network port in a single container.
- Type
object- Required
containerPort
.spec.init_containers[].readinessProbe
- Description
- 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
- Type
object
.spec.init_containers[].readinessProbe.exec
- Description
- Exec specifies the action to take.
- Type
object
.spec.init_containers[].readinessProbe.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. 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.
- Type
array
.spec.init_containers[].readinessProbe.exec.command[]
- Type
string
.spec.init_containers[].readinessProbe.grpc
- Description
- GRPC specifies an action involving a GRPC port.
- Type
object- Required
port
.spec.init_containers[].readinessProbe.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.init_containers[].readinessProbe.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.init_containers[].readinessProbe.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.spec.init_containers[].readinessProbe.tcpSocket
- Description
- TCPSocket specifies an action involving a TCP port.
- Type
object- Required
port
.spec.init_containers[].resizePolicy
- Description
- Resources resize policy for the container.
- Type
array
.spec.init_containers[].resizePolicy[]
- Description
- ContainerResizePolicy represents resource resize policy for the container.
- Type
object- Required
resourceNamerestartPolicy
.spec.init_containers[].resources
- Description
- Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
object
.spec.init_containers[].resources.claims
- Description
- Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
- Type
array
.spec.init_containers[].resources.claims[]
- Description
- ResourceClaim references one entry in PodSpec.ResourceClaims.
- Type
object- Required
name
.spec.init_containers[].resources.limits
- Description
- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
object
.spec.init_containers[].resources.requests
- Description
- 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/
- Type
object
.spec.init_containers[].securityContext
- Description
- 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/
- Type
object
.spec.init_containers[].securityContext.capabilities
- Description
- 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.
- Type
object
.spec.init_containers[].securityContext.capabilities.add
- Description
- Added capabilities
- Type
array
.spec.init_containers[].securityContext.capabilities.add[]
- Description
- Capability represent POSIX capabilities type
- Type
string
.spec.init_containers[].securityContext.capabilities.drop
- Description
- Removed capabilities
- Type
array
.spec.init_containers[].securityContext.capabilities.drop[]
- Description
- Capability represent POSIX capabilities type
- Type
string
.spec.init_containers[].securityContext.seLinuxOptions
- Description
- 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.
- Type
object
.spec.init_containers[].securityContext.seccompProfile
- Description
- 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.
- Type
object- Required
type
.spec.init_containers[].securityContext.windowsOptions
- Description
- 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.
- Type
object
.spec.init_containers[].startupProbe
- Description
- 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
- Type
object
.spec.init_containers[].startupProbe.exec
- Description
- Exec specifies the action to take.
- Type
object
.spec.init_containers[].startupProbe.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. 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.
- Type
array
.spec.init_containers[].startupProbe.exec.command[]
- Type
string
.spec.init_containers[].startupProbe.grpc
- Description
- GRPC specifies an action involving a GRPC port.
- Type
object- Required
port
.spec.init_containers[].startupProbe.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.init_containers[].startupProbe.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.init_containers[].startupProbe.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.spec.init_containers[].startupProbe.tcpSocket
- Description
- TCPSocket specifies an action involving a TCP port.
- Type
object- Required
port
.spec.init_containers[].volumeDevices
- Description
- volumeDevices is the list of block devices to be used by the container.
- Type
array
.spec.init_containers[].volumeDevices[]
- Description
- volumeDevice describes a mapping of a raw block device within a container.
- Type
object- Required
devicePathname
.spec.init_containers[].volumeMounts
- Description
- Pod volumes to mount into the container's filesystem. Cannot be updated.
- Type
array
.spec.init_containers[].volumeMounts[]
- Description
- VolumeMount describes a mounting of a Volume within a container.
- Type
object- Required
mountPathname
.spec.initContainers
- Description
- InitContainers defines initialization containers for the pod
- Type
array
.spec.initContainers[]
- Description
- A single application container that you want to run within a pod.
- Type
object- Required
name
.spec.initContainers[].args
- Description
- 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: i.e. "$$(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
- Type
array
.spec.initContainers[].args[]
- Type
string
.spec.initContainers[].command
- Description
- 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: i.e. "$$(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
- Type
array
.spec.initContainers[].command[]
- Type
string
.spec.initContainers[].env
- Description
- List of environment variables to set in the container. Cannot be updated.
- Type
array
.spec.initContainers[].env[]
- Description
- EnvVar represents an environment variable present in a Container.
- Type
object- Required
name
.spec.initContainers[].env[].valueFrom
- Description
- Source for the environment variable's value. Cannot be used if value is not empty.
- Type
object
.spec.initContainers[].env[].valueFrom.configMapKeyRef
- Description
- Selects a key of a ConfigMap.
- Type
object- Required
key
.spec.initContainers[].env[].valueFrom.fieldRef
- Description
- 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.
- Type
object- Required
fieldPath
.spec.initContainers[].env[].valueFrom.resourceFieldRef
- Description
- 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 currently supported.
- Type
object- Required
resource
.spec.initContainers[].env[].valueFrom.secretKeyRef
- Description
- Selects a key of a secret in the pod's namespace
- Type
object- Required
key
.spec.initContainers[].envFrom
- Description
- 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.
- Type
array
.spec.initContainers[].envFrom[]
- Description
- EnvFromSource represents the source of a set of ConfigMaps
- Type
object
.spec.initContainers[].envFrom[].configMapRef
- Description
- The ConfigMap to select from
- Type
object
.spec.initContainers[].envFrom[].secretRef
- Description
- The Secret to select from
- Type
object
.spec.initContainers[].lifecycle
- Description
- Actions that the management system should take in response to container lifecycle events. Cannot be updated.
- Type
object
.spec.initContainers[].lifecycle.postStart
- Description
- 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
- Type
object
.spec.initContainers[].lifecycle.postStart.exec
- Description
- Exec specifies the action to take.
- Type
object
.spec.initContainers[].lifecycle.postStart.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. 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.
- Type
array
.spec.initContainers[].lifecycle.postStart.exec.command[]
- Type
string
.spec.initContainers[].lifecycle.postStart.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.spec.initContainers[].lifecycle.postStart.sleep
- Description
- Sleep represents the duration that the container should sleep before being terminated.
- Type
object- Required
seconds
.spec.initContainers[].lifecycle.postStart.tcpSocket
- Description
- 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.
- Type
object- Required
port
.spec.initContainers[].lifecycle.preStop
- Description
- PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. 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
- Type
object
.spec.initContainers[].lifecycle.preStop.exec
- Description
- Exec specifies the action to take.
- Type
object
.spec.initContainers[].lifecycle.preStop.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. 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.
- Type
array
.spec.initContainers[].lifecycle.preStop.exec.command[]
- Type
string
.spec.initContainers[].lifecycle.preStop.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.spec.initContainers[].lifecycle.preStop.sleep
- Description
- Sleep represents the duration that the container should sleep before being terminated.
- Type
object- Required
seconds
.spec.initContainers[].lifecycle.preStop.tcpSocket
- Description
- 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.
- Type
object- Required
port
.spec.initContainers[].livenessProbe
- Description
- 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
- Type
object
.spec.initContainers[].livenessProbe.exec
- Description
- Exec specifies the action to take.
- Type
object
.spec.initContainers[].livenessProbe.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. 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.
- Type
array
.spec.initContainers[].livenessProbe.exec.command[]
- Type
string
.spec.initContainers[].livenessProbe.grpc
- Description
- GRPC specifies an action involving a GRPC port.
- Type
object- Required
port
.spec.initContainers[].livenessProbe.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.initContainers[].livenessProbe.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.initContainers[].livenessProbe.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.spec.initContainers[].livenessProbe.tcpSocket
- Description
- TCPSocket specifies an action involving a TCP port.
- Type
object- Required
port
.spec.initContainers[].ports
- Description
- 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.
- Type
array
.spec.initContainers[].ports[]
- Description
- ContainerPort represents a network port in a single container.
- Type
object- Required
containerPort
.spec.initContainers[].readinessProbe
- Description
- 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
- Type
object
.spec.initContainers[].readinessProbe.exec
- Description
- Exec specifies the action to take.
- Type
object
.spec.initContainers[].readinessProbe.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. 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.
- Type
array
.spec.initContainers[].readinessProbe.exec.command[]
- Type
string
.spec.initContainers[].readinessProbe.grpc
- Description
- GRPC specifies an action involving a GRPC port.
- Type
object- Required
port
.spec.initContainers[].readinessProbe.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.initContainers[].readinessProbe.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.initContainers[].readinessProbe.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.spec.initContainers[].readinessProbe.tcpSocket
- Description
- TCPSocket specifies an action involving a TCP port.
- Type
object- Required
port
.spec.initContainers[].resizePolicy
- Description
- Resources resize policy for the container.
- Type
array
.spec.initContainers[].resizePolicy[]
- Description
- ContainerResizePolicy represents resource resize policy for the container.
- Type
object- Required
resourceNamerestartPolicy
.spec.initContainers[].resources
- Description
- Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
object
.spec.initContainers[].resources.claims
- Description
- Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
- Type
array
.spec.initContainers[].resources.claims[]
- Description
- ResourceClaim references one entry in PodSpec.ResourceClaims.
- Type
object- Required
name
.spec.initContainers[].resources.limits
- Description
- Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- Type
object
.spec.initContainers[].resources.requests
- Description
- 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/
- Type
object
.spec.initContainers[].securityContext
- Description
- 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/
- Type
object
.spec.initContainers[].securityContext.capabilities
- Description
- 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.
- Type
object
.spec.initContainers[].securityContext.capabilities.add
- Description
- Added capabilities
- Type
array
.spec.initContainers[].securityContext.capabilities.add[]
- Description
- Capability represent POSIX capabilities type
- Type
string
.spec.initContainers[].securityContext.capabilities.drop
- Description
- Removed capabilities
- Type
array
.spec.initContainers[].securityContext.capabilities.drop[]
- Description
- Capability represent POSIX capabilities type
- Type
string
.spec.initContainers[].securityContext.seLinuxOptions
- Description
- 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.
- Type
object
.spec.initContainers[].securityContext.seccompProfile
- Description
- 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.
- Type
object- Required
type
.spec.initContainers[].securityContext.windowsOptions
- Description
- 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.
- Type
object
.spec.initContainers[].startupProbe
- Description
- 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
- Type
object
.spec.initContainers[].startupProbe.exec
- Description
- Exec specifies the action to take.
- Type
object
.spec.initContainers[].startupProbe.exec.command
- Description
- Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. 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.
- Type
array
.spec.initContainers[].startupProbe.exec.command[]
- Type
string
.spec.initContainers[].startupProbe.grpc
- Description
- GRPC specifies an action involving a GRPC port.
- Type
object- Required
port
.spec.initContainers[].startupProbe.httpGet
- Description
- HTTPGet specifies the http request to perform.
- Type
object- Required
port
.spec.initContainers[].startupProbe.httpGet.httpHeaders
- Description
- Custom headers to set in the request. HTTP allows repeated headers.
- Type
array
.spec.initContainers[].startupProbe.httpGet.httpHeaders[]
- Description
- HTTPHeader describes a custom header to be used in HTTP probes
- Type
object- Required
namevalue
.spec.initContainers[].startupProbe.tcpSocket
- Description
- TCPSocket specifies an action involving a TCP port.
- Type
object- Required
port
.spec.initContainers[].volumeDevices
- Description
- volumeDevices is the list of block devices to be used by the container.
- Type
array
.spec.initContainers[].volumeDevices[]
- Description
- volumeDevice describes a mapping of a raw block device within a container.
- Type
object- Required
devicePathname
.spec.initContainers[].volumeMounts
- Description
- Pod volumes to mount into the container's filesystem. Cannot be updated.
- Type
array
.spec.initContainers[].volumeMounts[]
- Description
- VolumeMount describes a mounting of a Volume within a container.
- Type
object- Required
mountPathname
.spec.maintenanceWindows
- Description
- MaintenanceWindows defines time windows for maintenance operations
- Type
array
.spec.maintenanceWindows[]
- Description
- MaintenanceWindow describes the time window when the operator is allowed to do maintenance on a cluster.
- Type
object
.spec.masterServiceAnnotations
- Description
- MasterServiceAnnotations defines annotations for master service
- Type
object
.spec.nodeAffinity
- Description
- NodeAffinity defines node affinity rules for pod scheduling
- Type
object
.spec.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution
- Description
- The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
- Type
array
.spec.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
- Description
- An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
- Type
object- Required
preferenceweight
.spec.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference
- Description
- A node selector term, associated with the corresponding weight.
- Type
object
.spec.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions
- Description
- A list of node selector requirements by node's labels.
- Type
array
.spec.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[]
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[].values
- Description
- 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
- Type
array
.spec.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[].values[]
- Type
string
.spec.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields
- Description
- A list of node selector requirements by node's fields.
- Type
array
.spec.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[]
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[].values
- Description
- 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
- Type
array
.spec.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[].values[]
- Type
string
.spec.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
- Description
- If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
- Type
object- Required
nodeSelectorTerms
.spec.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms
- Description
- Required. A list of node selector terms. The terms are ORed.
- Type
array
.spec.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[]
- Description
- A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
- Type
object
.spec.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions
- Description
- A list of node selector requirements by node's labels.
- Type
array
.spec.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[]
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[].values
- Description
- 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
- Type
array
.spec.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[].values[]
- Type
string
.spec.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields
- Description
- A list of node selector requirements by node's fields.
- Type
array
.spec.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[]
- Description
- A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[].values
- Description
- 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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
- Type
array
.spec.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[].values[]
- Type
string
.spec.nodeSelector
- Description
- NodeSelector defines node labels for pod scheduling
- Type
object
.spec.patroni
- Description
- Patroni configuration for cluster management
- Type
object
.spec.patroni.initdb
- Description
- InitDB parameters for database initialization
- Type
object
.spec.patroni.pg_hba
- Description
- Custom pg_hba.conf entries
- Type
array
.spec.patroni.pg_hba[]
- Type
string
.spec.patroni.slots
- Description
- Replication slots configuration
- Type
object
.spec.pgpool2Settings
- Description
- Pgpool2Settings defines Pgpool-II configuration
- Type
object
.spec.pgpool2Settings.resources
- Description
- Resources specifies CPU and memory requirements for Pgpool-II containers
- Type
object
.spec.pgpool2Settings.resources.limits
- Description
- ResourceLimits defines the maximum resources allowed for containers
- Type
object
.spec.pgpool2Settings.resources.requests
- Description
- ResourceRequests defines the minimum resources required for containers
- Type
object
.spec.podAnnotations
- Description
- PodAnnotations defines annotations to add to pods
- Type
object
.spec.postgresql
- Description
- PostgreSQL version and configuration parameters including: - PostgreSQL major version (e.g. "14") - Configuration parameters (postgresql.conf) - Configuration parameters (postgresql.conf) PostgreSQL version and configuration parameters
- Type
object- Required
version
.spec.postgresql.parameters
- Description
- PostgreSQL configuration parameters (postgresql.conf)
- Type
object
.spec.preparedDatabases
- Description
- PreparedDatabases defines databases with pre-configured schemas and roles
- Type
object
.spec.repairOption
- Description
- RepairOption defines options for cluster repair
- Type
object
.spec.replicaServiceAnnotations
- Description
- ReplicaServiceAnnotations defines annotations for replica service
- Type
object
.spec.resources
- Description
- Resource requests and limits for PostgreSQL containers
- Type
object
.spec.resources.limits
- Description
- ResourceLimits defines the maximum resources allowed for containers
- Type
object
.spec.resources.requests
- Description
- ResourceRequests defines the minimum resources required for containers
- Type
object
.spec.serviceAnnotations
- Description
- ServiceAnnotations defines annotations to add to services
- Type
object
.spec.serviceTemplates
- Description
- ServiceTemplates defines custom service templates
- Type
object
.spec.sidecars
- Description
- Sidecars defines additional containers to run in the pod
- Type
array
.spec.sidecars[]
- Description
- Sidecar defines a container to be run in the same pod as the Postgres container.
- Type
object
.spec.sidecars[].env
- Description
- Env defines environment variables to set in the sidecar container
- Type
array
.spec.sidecars[].env[]
- Description
- EnvVar represents an environment variable present in a Container.
- Type
object- Required
name
.spec.sidecars[].env[].valueFrom
- Description
- Source for the environment variable's value. Cannot be used if value is not empty.
- Type
object
.spec.sidecars[].env[].valueFrom.configMapKeyRef
- Description
- Selects a key of a ConfigMap.
- Type
object- Required
key
.spec.sidecars[].env[].valueFrom.fieldRef
- Description
- 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.
- Type
object- Required
fieldPath
.spec.sidecars[].env[].valueFrom.resourceFieldRef
- Description
- 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 currently supported.
- Type
object- Required
resource
.spec.sidecars[].env[].valueFrom.secretKeyRef
- Description
- Selects a key of a secret in the pod's namespace
- Type
object- Required
key
.spec.sidecars[].ports
- Description
- Ports defines the network ports to expose from the sidecar container
- Type
array
.spec.sidecars[].ports[]
- Description
- ContainerPort represents a network port in a single container.
- Type
object- Required
containerPort
.spec.sidecars[].resources
- Description
- Resources defines CPU and memory requirements for the sidecar container
- Type
object
.spec.sidecars[].resources.limits
- Description
- ResourceLimits defines the maximum resources allowed for containers
- Type
object
.spec.sidecars[].resources.requests
- Description
- ResourceRequests defines the minimum resources required for containers
- Type
object
.spec.standby
- Description
- StandbyCluster defines configuration for standby clusters
- Type
object
.spec.streams
- Description
- Streams defines configuration for streaming data
- Type
array
.spec.streams[]
- Description
- Stream defines properties for creating FabricEventStream resources
- Type
object- Required
applicationIddatabasetables
.spec.streams[].filter
- Description
- Filter specifies optional filtering conditions for the event stream
- Type
object
.spec.streams[].tables
- Description
- Tables defines the mapping of table names to their stream configurations
- Type
object
.spec.tls
- Description
- TLS defines TLS configuration for the cluster
- Type
object
.spec.tolerations
- Description
- Tolerations defines pod tolerations for node taints
- Type
array
.spec.tolerations[]
- Description
- The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
- Type
object
.spec.upgradeOption
- Description
- UpgradeOption defines upgrade options
- Type
object
.spec.users
- Description
- Users defines additional PostgreSQL users and their roles
- Type
object
.spec.usersCustomizedPasswd
- Description
- UsersCustomizedPasswd stores custom passwords for users
- Type
object
.spec.usersWithInPlaceSecretRotation
- Description
- UsersWithInPlaceSecretRotation defines users requiring in-place secret rotation
- Type
array
.spec.usersWithInPlaceSecretRotation[]
- Type
string
.spec.usersWithSecretRotation
- Description
- UsersWithSecretRotation defines users requiring secret rotation
- Type
array
.spec.usersWithSecretRotation[]
- Type
string
.spec.volume
- Description
- Volume configuration for PostgreSQL data storage
- Type
object- Required
size
.spec.volume.selector
- Description
- Selector for matching existing PersistentVolumeClaims
- Type
object
.spec.volume.selector.matchExpressions
- Description
- matchExpressions is a list of label selector requirements. The requirements are ANDed.
- Type
array
.spec.volume.selector.matchExpressions[]
- Description
- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
object- Required
keyoperator
.spec.volume.selector.matchExpressions[].values
- Description
- 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.
- Type
array
.spec.volume.selector.matchExpressions[].values[]
- Type
string
.spec.volume.selector.matchLabels
- Description
- 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.
- Type
object
.status
- Description
- Status defines the observed state of the PostgreSQL cluster including current status, patroni state, and any error messages.
- Type
object
.status.patroniStatus
- Description
- PatroniStatus contains status information for each Patroni-managed PostgreSQL instance
- Type
object
.status.upgradeStatus
- Description
- UpgradeStatus tracks version information for operator and custom resource upgrades
- Type
object
API Endpoints
The following API endpoints are available:
/apis/acid.zalan.do/v1/namespaces/{namespace}/postgresqlsDELETE: delete collection of postgresqlGET: list objects of kind postgresqlPOST: create a new postgresql
/apis/acid.zalan.do/v1/namespaces/{namespace}/postgresqls/{name}DELETE: delete the specified postgresqlGET: read the specified postgresqlPATCH: partially update the specified postgresqlPUT: replace the specified postgresql
/apis/acid.zalan.do/v1/namespaces/{namespace}/postgresqls/{name}/statusGET: read status of the specified postgresqlPATCH: partially update status of the specified postgresqlPUT: replace status of the specified postgresql
/apis/acid.zalan.do/v1/namespaces/{namespace}/postgresqls
- HTTP method
DELETE- Description
- delete collection of postgresql
- HTTP responses
- HTTP method
GET- Description
- list objects of kind postgresql
- HTTP responses
- HTTP method
POST- Description
- create a new postgresql
- Query parameters
- Body parameters
- HTTP responses
/apis/acid.zalan.do/v1/namespaces/{namespace}/postgresqls/{name}
- HTTP method
DELETE- Description
- delete the specified postgresql
- Query parameters
- HTTP responses
- HTTP method
GET- Description
- read the specified postgresql
- HTTP responses
- HTTP method
PATCH- Description
- partially update the specified postgresql
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace the specified postgresql
- Query parameters
- Body parameters
- HTTP responses
/apis/acid.zalan.do/v1/namespaces/{namespace}/postgresqls/{name}/status
- HTTP method
GET- Description
- read status of the specified postgresql
- HTTP responses
- HTTP method
PATCH- Description
- partially update status of the specified postgresql
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace status of the specified postgresql
- Query parameters
- Body parameters
- HTTP responses