Upgrade go to 1.19, enforce in Makefile (#494)
diff --git a/.github/workflows/smoke-tests.yaml b/.github/workflows/smoke-tests.yaml
index 07c7a61..20b6c15 100644
--- a/.github/workflows/smoke-tests.yaml
+++ b/.github/workflows/smoke-tests.yaml
@@ -44,7 +44,7 @@
strategy:
matrix:
- go: [ '1.17' ]
+ go: [ '1.19' ]
steps:
# Setup
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
index 093c187..1478676 100644
--- a/.github/workflows/tests.yaml
+++ b/.github/workflows/tests.yaml
@@ -29,7 +29,7 @@
strategy:
matrix:
- go: [ '1.17' ]
+ go: [ '1.19' ]
steps:
# Setup
diff --git a/Makefile b/Makefile
index 7d81ab4..089461b 100644
--- a/Makefile
+++ b/Makefile
@@ -18,6 +18,13 @@
# Produce CRDs that work back to Kubernetes 1.11 (no version conversion)
CRD_OPTIONS ?= "crd:trivialVersions=true,preserveUnknownFields=false"
+GO_VERSION = $(shell go version | sed -r 's/^.*([0-9]+\.[0-9]+\.[0-9]+).*$$/\1/g')
+REQUIRED_GO_VERSION = $(shell cat go.mod | grep -E 'go [1-9]\.[0-9]+' | sed -r 's/^go ([0-9]+\.[0-9]+)$$/\1/g')
+
+ifeq (,$(findstring $(REQUIRED_GO_VERSION),$(GO_VERSION)))
+$(error Unsupported go version found $(GO_VERSION), please install go $(REQUIRED_GO_VERSION))
+endif
+
# Image URL to use all building/pushing image targets
NAME ?= solr-operator
REPOSITORY ?= $(or $(NAMESPACE:%/=%), apache)
@@ -36,7 +43,7 @@
ARCH = $(shell go env GOARCH)
KUSTOMIZE_VERSION=v4.5.2
-CONTROLLER_GEN_VERSION=v0.5.0
+CONTROLLER_GEN_VERSION=v0.6.0
GO_LICENSES_VERSION=v1.0.0
GINKGO_VERSION = $(shell cat go.mod | grep 'github.com/onsi/ginkgo' | sed 's/.*\(v.*\)$$/\1/g')
diff --git a/api/v1beta1/groupversion_info.go b/api/v1beta1/groupversion_info.go
index 9dfc906..2b15ed3 100644
--- a/api/v1beta1/groupversion_info.go
+++ b/api/v1beta1/groupversion_info.go
@@ -16,8 +16,8 @@
*/
// Package v1beta1 contains API Schema definitions for the solr.apache.org v1beta1 API group
-//+kubebuilder:object:generate=true
-//+groupName=solr.apache.org
+// +kubebuilder:object:generate=true
+// +groupName=solr.apache.org
package v1beta1
import (
diff --git a/api/v1beta1/solrcloud_types.go b/api/v1beta1/solrcloud_types.go
index 1d2f6f8..bbbeac8 100644
--- a/api/v1beta1/solrcloud_types.go
+++ b/api/v1beta1/solrcloud_types.go
@@ -349,8 +349,8 @@
EmptyDir *corev1.EmptyDirVolumeSource `json:"emptyDir,omitempty"`
}
-//+kubebuilder:validation:MinProperties:=2
-//+kubebuilder:validation:MaxProperties:=2
+// +kubebuilder:validation:MinProperties:=2
+// +kubebuilder:validation:MaxProperties:=2
type SolrBackupRepository struct {
// A name used to identify this local storage profile. Values should follow RFC-1123. (See here for more details:
// https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names)
diff --git a/build/Dockerfile b/build/Dockerfile
index 121258b..ca83eb0 100644
--- a/build/Dockerfile
+++ b/build/Dockerfile
@@ -11,7 +11,7 @@
# limitations under the License.
# Build the manager binary
-FROM golang:1.17 as builder
+FROM golang:1.19 as builder
WORKDIR /workspace
ARG GO111MODULE=on
diff --git a/config/crd/bases/solr.apache.org_solrbackups.yaml b/config/crd/bases/solr.apache.org_solrbackups.yaml
index f0d10e0..7ee1c65 100644
--- a/config/crd/bases/solr.apache.org_solrbackups.yaml
+++ b/config/crd/bases/solr.apache.org_solrbackups.yaml
@@ -20,7 +20,7 @@
annotations:
operator.solr.apache.org/version: v0.7.0-prerelease
argocd.argoproj.io/sync-options: Replace=true
- controller-gen.kubebuilder.io/version: v0.5.0
+ controller-gen.kubebuilder.io/version: v0.6.0
creationTimestamp: null
name: solrbackups.solr.apache.org
spec:
@@ -63,10 +63,14 @@
description: SolrBackup is the Schema for the solrbackups API
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -79,28 +83,42 @@
type: string
type: array
location:
- description: The location to store the backup in the specified backup repository.
+ description: The location to store the backup in the specified backup
+ repository.
type: string
recurrence:
- description: "Set this backup to be taken recurrently, with options for scheduling and storage. \n NOTE: This is only supported for Solr Clouds version 8.9+, as it uses the incremental backup API."
+ description: "Set this backup to be taken recurrently, with options
+ for scheduling and storage. \n NOTE: This is only supported for
+ Solr Clouds version 8.9+, as it uses the incremental backup API."
properties:
disabled:
default: false
- description: Disable the recurring backups. Note this will not affect any currently-running backup.
+ description: Disable the recurring backups. Note this will not
+ affect any currently-running backup.
type: boolean
maxSaved:
default: 5
- description: Define the number of backup points to save for this backup at any given time. The oldest backups will be deleted if too many exist when a backup is taken. If not provided, this defaults to 5.
+ description: Define the number of backup points to save for this
+ backup at any given time. The oldest backups will be deleted
+ if too many exist when a backup is taken. If not provided, this
+ defaults to 5.
minimum: 1
type: integer
schedule:
- description: "Perform a backup on the given schedule, in CRON format. \n Multiple CRON syntaxes are supported - Standard CRON (e.g. \"CRON_TZ=Asia/Seoul 0 6 * * ?\") - Predefined Schedules (e.g. \"@yearly\", \"@weekly\", \"@daily\", etc.) - Intervals (e.g. \"@every 10h30m\") \n For more information please check this reference: https://pkg.go.dev/github.com/robfig/cron/v3?utm_source=godoc#hdr-CRON_Expression_Format"
+ description: "Perform a backup on the given schedule, in CRON
+ format. \n Multiple CRON syntaxes are supported - Standard
+ CRON (e.g. \"CRON_TZ=Asia/Seoul 0 6 * * ?\") - Predefined
+ Schedules (e.g. \"@yearly\", \"@weekly\", \"@daily\", etc.)
+ \ - Intervals (e.g. \"@every 10h30m\") \n For more information
+ please check this reference: https://pkg.go.dev/github.com/robfig/cron/v3?utm_source=godoc#hdr-CRON_Expression_Format"
type: string
required:
- schedule
type: object
repositoryName:
- description: The name of the repository to use for the backup. Defaults to "legacy_local_repository" if not specified (the auto-configured repository for legacy singleton volumes).
+ description: The name of the repository to use for the backup. Defaults
+ to "legacy_local_repository" if not specified (the auto-configured
+ repository for legacy singleton volumes).
maxLength: 100
minLength: 1
pattern: '[a-zA-Z0-9]([-_a-zA-Z0-9]*[a-zA-Z0-9])?'
@@ -120,7 +138,8 @@
collectionBackupStatuses:
description: The status of each collection's backup progress
items:
- description: CollectionBackupStatus defines the progress of a Solr Collection's backup
+ description: CollectionBackupStatus defines the progress of a Solr
+ Collection's backup
properties:
asyncBackupStatus:
description: The status of the asynchronous backup call to solr
@@ -162,24 +181,29 @@
history:
description: The status history of recurring backups
items:
- description: IndividualSolrBackupStatus defines the observed state of a single issued SolrBackup
+ description: IndividualSolrBackupStatus defines the observed state
+ of a single issued SolrBackup
properties:
collectionBackupStatuses:
description: The status of each collection's backup progress
items:
- description: CollectionBackupStatus defines the progress of a Solr Collection's backup
+ description: CollectionBackupStatus defines the progress of
+ a Solr Collection's backup
properties:
asyncBackupStatus:
- description: The status of the asynchronous backup call to solr
+ description: The status of the asynchronous backup call
+ to solr
type: string
backupName:
- description: BackupName of this collection's backup in Solr
+ description: BackupName of this collection's backup in
+ Solr
type: string
collection:
description: Solr Collection name
type: string
finishTimestamp:
- description: Time that the collection backup finished at
+ description: Time that the collection backup finished
+ at
format: date-time
type: string
finished:
diff --git a/config/crd/bases/solr.apache.org_solrclouds.yaml b/config/crd/bases/solr.apache.org_solrclouds.yaml
index b18aa49..aa59dec 100644
--- a/config/crd/bases/solr.apache.org_solrclouds.yaml
+++ b/config/crd/bases/solr.apache.org_solrclouds.yaml
@@ -20,7 +20,7 @@
annotations:
operator.solr.apache.org/version: v0.7.0-prerelease
argocd.argoproj.io/sync-options: Replace=true
- controller-gen.kubebuilder.io/version: v0.5.0
+ controller-gen.kubebuilder.io/version: v0.6.0
creationTimestamp: null
name: solrclouds.solr.apache.org
spec:
@@ -68,10 +68,14 @@
description: SolrCloud is the Schema for the solrclouds API
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -79,36 +83,50 @@
description: SolrCloudSpec defines the desired state of SolrCloud
properties:
additionalLibs:
- description: 'List of paths in the Solr Docker image to load in the classpath. Note: Solr Modules will be auto-loaded if specified in the "solrModules" property. There is no need to specify them here as well.'
+ description: 'List of paths in the Solr Docker image to load in the
+ classpath. Note: Solr Modules will be auto-loaded if specified in
+ the "solrModules" property. There is no need to specify them here
+ as well.'
items:
type: string
type: array
backupRepositories:
- description: Allows specification of multiple different "repositories" for Solr to use when backing up data.
+ description: Allows specification of multiple different "repositories"
+ for Solr to use when backing up data.
items:
maxProperties: 2
minProperties: 2
properties:
gcs:
- description: A GCSRepository for Solr to use when backing up and restoring collections.
+ description: A GCSRepository for Solr to use when backing up
+ and restoring collections.
properties:
baseLocation:
- description: An already-created chroot within the bucket to store data in. Defaults to the root path "/" if not specified.
+ description: An already-created chroot within the bucket
+ to store data in. Defaults to the root path "/" if not
+ specified.
type: string
bucket:
- description: The name of the GCS bucket that all backup data will be stored in
+ description: The name of the GCS bucket that all backup
+ data will be stored in
type: string
gcsCredentialSecret:
- description: The name & key of a Kubernetes secret holding a Google cloud service account key. Must be set unless deployed in GKE and making use of Google's "Workplace Identity" feature.
+ description: The name & key of a Kubernetes secret holding
+ a Google cloud service account key. Must be set unless
+ deployed in GKE and making use of Google's "Workplace
+ Identity" feature.
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must
+ be defined
type: boolean
required:
- key
@@ -117,89 +135,124 @@
- bucket
type: object
name:
- description: 'A name used to identify this local storage profile. Values should follow RFC-1123. (See here for more details: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names)'
+ description: 'A name used to identify this local storage profile. Values
+ should follow RFC-1123. (See here for more details: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names)'
maxLength: 100
minLength: 1
pattern: '[a-zA-Z0-9]([-_a-zA-Z0-9]*[a-zA-Z0-9])?'
type: string
s3:
- description: An S3Repository for Solr to use when backing up and restoring collections.
+ description: An S3Repository for Solr to use when backing up
+ and restoring collections.
properties:
baseLocation:
- description: An already-created chroot within the bucket to store data in. Defaults to the root path "/" if not specified.
+ description: An already-created chroot within the bucket
+ to store data in. Defaults to the root path "/" if not
+ specified.
type: string
bucket:
- description: The name of the S3 bucket that all backup data will be stored in
+ description: The name of the S3 bucket that all backup data
+ will be stored in
type: string
credentials:
- description: "Options for specifying S3Credentials. This is optional in case you want to mount this information yourself. However, if you do not include these credentials, and you do not load them yourself via a mount or EnvVars, you will likely see errors when taking s3 backups. \n If running in EKS, you can create an IAMServiceAccount that uses a role permissioned for this S3 bucket. Then use that serviceAccountName for your SolrCloud, and the credentials should be auto-populated."
+ description: "Options for specifying S3Credentials. This
+ is optional in case you want to mount this information
+ yourself. However, if you do not include these credentials,
+ and you do not load them yourself via a mount or EnvVars,
+ you will likely see errors when taking s3 backups. \n
+ If running in EKS, you can create an IAMServiceAccount
+ that uses a role permissioned for this S3 bucket. Then
+ use that serviceAccountName for your SolrCloud, and the
+ credentials should be auto-populated."
properties:
accessKeyIdSecret:
- description: The name & key of a Kubernetes secret holding an AWS Access Key ID
+ description: The name & key of a Kubernetes secret holding
+ an AWS Access Key ID
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key
+ must be defined
type: boolean
required:
- key
type: object
credentialsFileSecret:
- description: The name & key of a Kubernetes secret holding an AWS credentials file
+ description: The name & key of a Kubernetes secret holding
+ an AWS credentials file
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key
+ must be defined
type: boolean
required:
- key
type: object
secretAccessKeySecret:
- description: The name & key of a Kubernetes secret holding an AWS Secret Access Key
+ description: The name & key of a Kubernetes secret holding
+ an AWS Secret Access Key
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key
+ must be defined
type: boolean
required:
- key
type: object
sessionTokenSecret:
- description: The name & key of a Kubernetes secret holding an AWS Session Token
+ description: The name & key of a Kubernetes secret holding
+ an AWS Session Token
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key
+ must be defined
type: boolean
required:
- key
type: object
type: object
endpoint:
- description: The full endpoint URL to use when connecting with S3 (or a supported S3 compatible interface)
+ description: The full endpoint URL to use when connecting
+ with S3 (or a supported S3 compatible interface)
type: string
proxyUrl:
- description: The full proxy URL to use when connecting with S3
+ description: The full proxy URL to use when connecting with
+ S3
type: string
region:
description: The S3 region to store the backup data in
@@ -209,66 +262,106 @@
- region
type: object
volume:
- description: Allows specification of a "repository" for Solr to use when backing up data "locally".
+ description: Allows specification of a "repository" for Solr
+ to use when backing up data "locally".
properties:
directory:
- description: Select a custom directory name to mount the backup/restore data in the given volume. If not specified, then the name of the solrcloud will be used by default.
+ description: Select a custom directory name to mount the
+ backup/restore data in the given volume. If not specified,
+ then the name of the solrcloud will be used by default.
type: string
source:
- description: 'This is a volumeSource for a volume that will be mounted to all solrNodes to store backups and load restores. The data within the volume will be namespaced for this instance, so feel free to use the same volume for multiple clouds. Since the volume will be mounted to all solrNodes, it must be able to be written from multiple pods. If a PVC reference is given, the PVC must have `accessModes: - ReadWriteMany`. Other options are to use a NFS volume.'
+ description: 'This is a volumeSource for a volume that will
+ be mounted to all solrNodes to store backups and load
+ restores. The data within the volume will be namespaced
+ for this instance, so feel free to use the same volume
+ for multiple clouds. Since the volume will be mounted
+ to all solrNodes, it must be able to be written from multiple
+ pods. If a PVC reference is given, the PVC must have `accessModes:
+ - ReadWriteMany`. Other options are to use a NFS volume.'
properties:
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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 TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume that
+ you want to mount. Tip: Ensure that the filesystem
+ 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
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: '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).'
+ description: '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).'
format: int32
type: integer
readOnly:
- description: 'Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'Specify "true" to force and set the
+ ReadOnly property in VolumeMounts to "true". If
+ omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: boolean
volumeID:
- description: 'Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'Unique ID of the persistent disk resource
+ in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: string
required:
- volumeID
type: object
azureDisk:
- description: AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+ description: AzureDisk represents an Azure Data Disk
+ mount on the host and bind mount to the pod.
properties:
cachingMode:
- description: 'Host Caching mode: None, Read Only, Read Write.'
+ description: 'Host Caching mode: None, Read Only,
+ Read Write.'
type: string
diskName:
- description: The Name of the data disk in the blob storage
+ description: The Name of the data disk in the blob
+ storage
type: string
diskURI:
description: The URI the data disk in the blob storage
type: string
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must be a
+ filesystem type supported by the host operating
+ system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified.
type: string
kind:
- description: 'Expected values 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'
+ description: 'Expected values 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'
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write). ReadOnly
+ here will force the ReadOnly setting in VolumeMounts.
type: boolean
required:
- diskName
- diskURI
type: object
azureFile:
- description: AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
+ description: AzureFile represents an Azure File Service
+ mount on the host and bind mount to the pod.
properties:
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write). ReadOnly
+ here will force the ReadOnly setting in VolumeMounts.
type: boolean
secretName:
- description: the name of secret that contains Azure Storage Account Name and Key
+ description: the name of secret that contains Azure
+ Storage Account Name and Key
type: string
shareName:
description: Share Name
@@ -278,78 +371,136 @@
- shareName
type: object
cephfs:
- description: CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
+ description: CephFS represents a Ceph FS mount on the
+ host that shares a pod's lifetime
properties:
monitors:
- description: 'Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'Required: Monitors is a collection
+ of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
items:
type: string
type: array
path:
- description: 'Optional: Used as the mounted root, rather than the full Ceph tree, default is /'
+ description: 'Optional: Used as the mounted root,
+ rather than the full Ceph tree, default is /'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
secretFile:
- description: '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'
+ description: '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'
type: string
secretRef:
- description: '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'
+ description: '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'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
user:
- description: 'Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'Optional: User is the rados user name,
+ default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
required:
- monitors
type: object
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'
+ description: 'Cinder represents a cinder volume attached
+ and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
properties:
fsType:
- description: 'Filesystem type to mount. Must be a filesystem 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'
+ description: 'Filesystem type to mount. Must be
+ a filesystem 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'
type: string
readOnly:
- description: 'Optional: 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'
+ description: 'Optional: 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'
type: boolean
secretRef:
- description: 'Optional: points to a secret object containing parameters used to connect to OpenStack.'
+ description: 'Optional: points to a secret object
+ containing parameters used to connect to OpenStack.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
volumeID:
- description: 'volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'volume id used to identify the volume
+ in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
required:
- volumeID
type: object
configMap:
- description: ConfigMap represents a configMap that should populate this volume
+ description: ConfigMap represents a configMap that should
+ populate this volume
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: 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 '..'.
+ description: 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
+ '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to a path within
+ a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -357,81 +508,143 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its keys must be defined
+ description: Specify whether the ConfigMap or its
+ keys must be defined
type: boolean
type: object
csi:
- description: CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
+ description: CSI (Container Storage Interface) represents
+ ephemeral storage that is handled by certain external
+ CSI drivers (Beta feature).
properties:
driver:
- description: Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
+ description: Driver is the name of the CSI driver
+ that handles this volume. Consult with your admin
+ for the correct name as registered in the cluster.
type: string
fsType:
- description: Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
+ description: Filesystem type to mount. Ex. "ext4",
+ "xfs", "ntfs". If not provided, the empty value
+ is passed to the associated CSI driver which will
+ determine the default filesystem to apply.
type: string
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.
+ 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.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
readOnly:
- description: Specifies a read-only configuration for the volume. Defaults to false (read/write).
+ description: Specifies a read-only configuration
+ for the volume. Defaults to false (read/write).
type: boolean
volumeAttributes:
additionalProperties:
type: string
- description: VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
+ description: VolumeAttributes stores driver-specific
+ properties that are passed to the CSI driver.
+ Consult your driver's documentation for supported
+ values.
type: object
required:
- driver
type: object
downwardAPI:
- description: DownwardAPI represents downward API about the pod that should populate this volume
+ description: DownwardAPI represents downward API about
+ the pod that should populate this volume
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: Items is a list of downward API volume file
+ description: Items is a list of downward API volume
+ file
items:
- description: DownwardAPIVolumeFile represents information to create the file containing the pod field
+ description: DownwardAPIVolumeFile represents
+ information to create the file containing the
+ pod field
properties:
fieldRef:
- description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
+ description: 'Required: Selects a field of
+ the pod: only annotations, labels, name
+ and namespace are supported.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema the
+ FieldPath is written in terms of, defaults
+ to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to select
+ in the specified API version.
type: string
required:
- fieldPath
type: object
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative path name 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 ''..'''
+ description: 'Required: Path is the relative
+ path name 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 ''..'''
type: string
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.'
+ description: 'Selects a resource of the container:
+ only resources limits and requests (limits.cpu,
+ limits.memory, requests.cpu and requests.memory)
+ are currently supported.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required
+ for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output format
+ of the exposed resources, defaults to
+ "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -446,57 +659,140 @@
type: array
type: object
emptyDir:
- description: 'EmptyDir represents a temporary directory that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
+ description: 'EmptyDir represents a temporary directory
+ that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
properties:
medium:
- description: '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'
+ description: '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'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
+ description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: "Ephemeral represents a volume that is handled by a cluster storage driver (Alpha feature). 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."
+ description: "Ephemeral represents a volume that is
+ handled by a cluster storage driver (Alpha feature).
+ 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."
properties:
readOnly:
- description: Specifies a read-only configuration for the volume. Defaults to false (read/write).
+ description: Specifies a read-only configuration
+ for the volume. Defaults to false (read/write).
type: boolean
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). \n 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. \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."
+ 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). \n 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. \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."
properties:
metadata:
- description: 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.
+ description: 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.
type: object
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.
+ 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.
properties:
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'
+ description: 'AccessModes contains the desired
+ access modes the volume should have. More
+ info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. 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.'
+ description: 'This field can be used to
+ specify either: * An existing VolumeSnapshot
+ object (snapshot.storage.k8s.io/VolumeSnapshot)
+ * An existing PVC (PersistentVolumeClaim)
+ * An existing custom resource that implements
+ data population (Alpha) In order to use
+ custom resource types that implement data
+ population, the AnyVolumeDataSource feature
+ gate must be enabled. 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.'
properties:
apiGroup:
- description: 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.
+ description: 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.
type: string
kind:
- description: Kind is the type of resource being referenced
+ description: Kind is the type of resource
+ being referenced
type: string
name:
- description: Name is the name of resource being referenced
+ description: Name is the name of resource
+ being referenced
type: string
required:
- kind
- name
type: object
resources:
- description: 'Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'Resources represents the minimum
+ resources the volume should have. More
+ info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
@@ -505,7 +801,9 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum
+ amount of compute resources allowed.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -514,25 +812,49 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
selector:
- description: A label query over volumes to consider for binding.
+ description: A label query over volumes
+ to consider for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The
+ requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a set
+ of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -544,17 +866,29 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
storageClassName:
- description: 'Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'Name of the StorageClass required
+ by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
+ description: volumeMode defines what type
+ of volume is required by the claim. Value
+ of Filesystem is implied when not included
+ in claim spec.
type: string
volumeName:
- description: VolumeName is the binding reference to the PersistentVolume backing this claim.
+ description: VolumeName is the binding reference
+ to the PersistentVolume backing this claim.
type: string
type: object
required:
@@ -562,90 +896,151 @@
type: object
type: object
fc:
- description: FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
+ description: FC represents a Fibre Channel resource
+ that is attached to a kubelet's host machine and then
+ exposed to the pod.
properties:
fsType:
- description: 'Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type to mount. Must be
+ a filesystem type supported by the host operating
+ system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified. TODO: how
+ do we prevent errors in the filesystem from compromising
+ the machine'
type: string
lun:
description: 'Optional: FC target lun number'
format: int32
type: integer
readOnly:
- description: 'Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'Optional: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.'
type: boolean
targetWWNs:
- description: 'Optional: FC target worldwide names (WWNs)'
+ description: 'Optional: FC target worldwide names
+ (WWNs)'
items:
type: string
type: array
wwids:
- description: 'Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.'
+ description: 'Optional: FC volume world wide identifiers
+ (wwids) Either wwids or combination of targetWWNs
+ and lun must be set, but not both simultaneously.'
items:
type: string
type: array
type: object
flexVolume:
- description: FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
+ description: FlexVolume represents a generic volume
+ resource that is provisioned/attached using an exec
+ based plugin.
properties:
driver:
- description: Driver is the name of the driver to use for this volume.
+ description: Driver is the name of the driver to
+ use for this volume.
type: string
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
+ description: Filesystem type to mount. Must be a
+ filesystem type supported by the host operating
+ system. Ex. "ext4", "xfs", "ntfs". The default
+ filesystem depends on FlexVolume script.
type: string
options:
additionalProperties:
type: string
- description: 'Optional: Extra command options if any.'
+ description: 'Optional: Extra command options if
+ any.'
type: object
readOnly:
- description: 'Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'Optional: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.'
type: boolean
secretRef:
- description: '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.'
+ description: '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.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
required:
- driver
type: object
flocker:
- description: Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
+ description: Flocker represents a Flocker volume attached
+ to a kubelet's host machine. This depends on the Flocker
+ control service being running
properties:
datasetName:
- description: Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
+ description: Name of the dataset stored as metadata
+ -> name on the dataset for Flocker should be considered
+ as deprecated
type: string
datasetUUID:
- description: UUID of the dataset. This is unique identifier of a Flocker dataset
+ description: UUID of the dataset. This is unique
+ identifier of a Flocker dataset
type: string
type: object
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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 TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume that
+ you want to mount. Tip: Ensure that the filesystem
+ 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
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: '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). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: '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). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
format: int32
type: integer
pdName:
- description: 'Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'Unique name of the PD resource in
+ GCE. Used to identify the disk in GCE. More info:
+ https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: string
readOnly:
- description: 'ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'ReadOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: boolean
required:
- pdName
type: object
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.'
+ 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.'
properties:
directory:
- description: 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.
+ description: 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.
type: string
repository:
description: Repository URL
@@ -657,75 +1052,116 @@
- repository
type: object
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'
+ 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'
properties:
endpoints:
- description: 'EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'EndpointsName is the endpoint name
+ that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
path:
- description: 'Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'Path is the Glusterfs volume path.
+ More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
required:
- endpoints
- path
type: object
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.'
+ 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.'
properties:
path:
- description: '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'
+ description: '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'
type: string
type:
- description: 'Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
+ description: 'Type for HostPath Volume Defaults
+ to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
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'
+ 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'
properties:
chapAuthDiscovery:
- description: whether support iSCSI Discovery CHAP authentication
+ description: whether support iSCSI Discovery CHAP
+ authentication
type: boolean
chapAuthSession:
- description: whether support iSCSI Session CHAP authentication
+ description: whether support iSCSI Session CHAP
+ authentication
type: boolean
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume that
+ you want to mount. Tip: Ensure that the filesystem
+ 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#iscsi
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
initiatorName:
- description: Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
+ description: Custom iSCSI Initiator Name. If initiatorName
+ is specified with iscsiInterface simultaneously,
+ new iSCSI interface <target portal>:<volume name>
+ will be created for the connection.
type: string
iqn:
description: Target iSCSI Qualified Name.
type: string
iscsiInterface:
- description: iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
+ description: iSCSI Interface Name that uses an iSCSI
+ transport. Defaults to 'default' (tcp).
type: string
lun:
description: iSCSI Target Lun number.
format: int32
type: integer
portals:
- description: 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).
+ description: 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).
items:
type: string
type: array
readOnly:
- description: ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
+ description: ReadOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
type: boolean
secretRef:
- description: CHAP Secret for iSCSI target and initiator authentication
+ description: CHAP Secret for iSCSI target and initiator
+ authentication
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
targetPortal:
- description: 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).
+ description: 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).
type: string
required:
- iqn
@@ -733,89 +1169,154 @@
- targetPortal
type: object
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'
+ 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'
properties:
path:
- description: 'Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'Path that is exported by the NFS server.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
server:
- description: 'Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'Server is the hostname or IP address
+ of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- path
- server
type: object
persistentVolumeClaim:
- description: 'PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'PersistentVolumeClaimVolumeSource represents
+ a reference to a PersistentVolumeClaim in the same
+ namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
claimName:
- description: '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'
+ description: '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'
type: string
readOnly:
- description: Will force the ReadOnly setting in VolumeMounts. Default false.
+ description: Will force the ReadOnly setting in
+ VolumeMounts. Default false.
type: boolean
required:
- claimName
type: object
photonPersistentDisk:
- description: PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
+ description: PhotonPersistentDisk represents a PhotonController
+ persistent disk attached and mounted on kubelets host
+ machine
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must be a
+ filesystem type supported by the host operating
+ system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified.
type: string
pdID:
- description: ID that identifies Photon Controller persistent disk
+ description: ID that identifies Photon Controller
+ persistent disk
type: string
required:
- pdID
type: object
portworxVolume:
- description: PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
+ description: PortworxVolume represents a portworx volume
+ attached and mounted on kubelets host machine
properties:
fsType:
- description: FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
+ description: FSType represents the filesystem type
+ to mount Must be a filesystem type supported by
+ the host operating system. Ex. "ext4", "xfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write). ReadOnly
+ here will force the ReadOnly setting in VolumeMounts.
type: boolean
volumeID:
- description: VolumeID uniquely identifies a Portworx volume
+ description: VolumeID uniquely identifies a Portworx
+ volume
type: string
required:
- volumeID
type: object
projected:
- description: Items for all in one resources secrets, configmaps, and downward API
+ description: Items for all in one resources secrets,
+ configmaps, and downward API
properties:
defaultMode:
- description: 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.
+ description: 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.
format: int32
type: integer
sources:
description: list of volume projections
items:
- description: Projection that may be projected along with other supported volume types
+ description: Projection that may be projected
+ along with other supported volume types
properties:
configMap:
- description: information about the configMap data to project
+ description: information about the configMap
+ data to project
properties:
items:
- description: 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 '..'.
+ description: 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 '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to a
+ path within a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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
+ '..'.
type: string
required:
- key
@@ -823,54 +1324,98 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its keys must be defined
+ description: Specify whether the ConfigMap
+ or its keys must be defined
type: boolean
type: object
downwardAPI:
- description: information about the downwardAPI data to project
+ description: information about the downwardAPI
+ data to project
properties:
items:
- description: Items is a list of DownwardAPIVolume file
+ description: Items is a list of DownwardAPIVolume
+ file
items:
- description: DownwardAPIVolumeFile represents information to create the file containing the pod field
+ description: DownwardAPIVolumeFile represents
+ information to create the file containing
+ the pod field
properties:
fieldRef:
- description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
+ description: 'Required: Selects
+ a field of the pod: only annotations,
+ labels, name and namespace are
+ supported.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the
+ schema the FieldPath is written
+ in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field
+ to select in the specified
+ API version.
type: string
required:
- fieldPath
type: object
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative path name 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 ''..'''
+ description: 'Required: Path is the
+ relative path name 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 ''..'''
type: string
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.'
+ description: 'Selects a resource
+ of the container: only resources
+ limits and requests (limits.cpu,
+ limits.memory, requests.cpu and
+ requests.memory) are currently
+ supported.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name:
+ required for volumes, optional
+ for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output
+ format of the exposed resources,
+ defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
- description: 'Required: resource to select'
+ description: 'Required: resource
+ to select'
type: string
required:
- resource
@@ -881,22 +1426,54 @@
type: array
type: object
secret:
- description: information about the secret data to project
+ description: information about the secret
+ data to project
properties:
items:
- description: 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 '..'.
+ description: 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 '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to a
+ path within a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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
+ '..'.
type: string
required:
- key
@@ -904,24 +1481,47 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret
+ or its key must be defined
type: boolean
type: object
serviceAccountToken:
- description: information about the serviceAccountToken data to project
+ description: information about the serviceAccountToken
+ data to project
properties:
audience:
- description: 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.
+ description: 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.
type: string
expirationSeconds:
- description: 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.
+ description: 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.
format: int64
type: integer
path:
- description: Path is the path relative to the mount point of the file to project the token into.
+ description: Path is the path relative
+ to the mount point of the file to project
+ the token into.
type: string
required:
- path
@@ -930,103 +1530,155 @@
type: array
type: object
quobyte:
- description: Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
+ description: Quobyte represents a Quobyte mount on the
+ host that shares a pod's lifetime
properties:
group:
- description: Group to map volume access to Default is no group
+ description: Group to map volume access to Default
+ is no group
type: string
readOnly:
- description: ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
+ description: ReadOnly here will force the Quobyte
+ volume to be mounted with read-only permissions.
+ Defaults to false.
type: boolean
registry:
- description: 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
+ description: 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
type: string
tenant:
- description: Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ description: Tenant owning the given Quobyte volume
+ in the Backend Used with dynamically provisioned
+ Quobyte volumes, value is set by the plugin
type: string
user:
- description: User to map volume access to Defaults to serivceaccount user
+ description: User to map volume access to Defaults
+ to serivceaccount user
type: string
volume:
- description: Volume is a string that references an already created Quobyte volume by name.
+ description: Volume is a string that references
+ an already created Quobyte volume by name.
type: string
required:
- registry
- volume
type: object
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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#rbd TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume that
+ you want to mount. Tip: Ensure that the filesystem
+ 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#rbd
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
image:
description: 'The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
keyring:
- description: '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'
+ description: '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'
type: string
monitors:
- description: 'A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'A collection of Ceph monitors. More
+ info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
items:
type: string
type: array
pool:
- description: 'The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'The rados pool name. Default is rbd.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
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'
+ 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'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
user:
- description: 'The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'The rados user name. Default is admin.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- image
- monitors
type: object
scaleIO:
- description: ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
+ description: ScaleIO represents a ScaleIO persistent
+ volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
+ description: Filesystem type to mount. Must be a
+ filesystem type supported by the host operating
+ system. Ex. "ext4", "xfs", "ntfs". Default is
+ "xfs".
type: string
gateway:
- description: The host address of the ScaleIO API Gateway.
+ description: The host address of the ScaleIO API
+ Gateway.
type: string
protectionDomain:
- description: The name of the ScaleIO Protection Domain for the configured storage.
+ description: The name of the ScaleIO Protection
+ Domain for the configured storage.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write). ReadOnly
+ here will force the ReadOnly setting in VolumeMounts.
type: boolean
secretRef:
- description: SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
+ description: SecretRef references to the secret
+ for ScaleIO user and other sensitive information.
+ If this is not provided, Login operation will
+ fail.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
sslEnabled:
- description: Flag to enable/disable SSL communication with Gateway, default false
+ description: Flag to enable/disable SSL communication
+ with Gateway, default false
type: boolean
storageMode:
- description: Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
+ description: Indicates whether the storage for a
+ volume should be ThickProvisioned or ThinProvisioned.
+ Default is ThinProvisioned.
type: string
storagePool:
- description: The ScaleIO Storage Pool associated with the protection domain.
+ description: The ScaleIO Storage Pool associated
+ with the protection domain.
type: string
system:
- description: The name of the storage system as configured in ScaleIO.
+ description: The name of the storage system as configured
+ in ScaleIO.
type: string
volumeName:
- description: The name of a volume already created in the ScaleIO system that is associated with this volume source.
+ description: The name of a volume already created
+ in the ScaleIO system that is associated with
+ this volume source.
type: string
required:
- gateway
@@ -1034,26 +1686,59 @@
- system
type: object
secret:
- description: 'Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'Secret represents a secret that should
+ populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: 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 '..'.
+ description: 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
+ '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to a path within
+ a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -1061,49 +1746,78 @@
type: object
type: array
optional:
- description: Specify whether the Secret or its keys must be defined
+ description: Specify whether the Secret or its keys
+ must be defined
type: boolean
secretName:
- description: 'Name of the secret in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'Name of the secret in the pod''s namespace
+ to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
type: string
type: object
storageos:
- description: StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
+ description: StorageOS represents a StorageOS volume
+ attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must be a
+ filesystem type supported by the host operating
+ system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write). ReadOnly
+ here will force the ReadOnly setting in VolumeMounts.
type: boolean
secretRef:
- description: SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
+ description: SecretRef specifies the secret to use
+ for obtaining the StorageOS API credentials. If
+ not specified, default values will be attempted.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
volumeName:
- description: VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
+ description: VolumeName is the human-readable name
+ of the StorageOS volume. Volume names are only
+ unique within a namespace.
type: string
volumeNamespace:
- description: 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 do not pre-exist within StorageOS will be created.
+ description: 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 do
+ not pre-exist within StorageOS will be created.
type: string
type: object
vsphereVolume:
- description: VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
+ description: VsphereVolume represents a vSphere volume
+ attached and mounted on kubelets host machine
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must be a
+ filesystem type supported by the host operating
+ system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified.
type: string
storagePolicyID:
- description: Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
+ description: Storage Policy Based Management (SPBM)
+ profile ID associated with the StoragePolicyName.
type: string
storagePolicyName:
- description: Storage Policy Based Management (SPBM) profile name.
+ description: Storage Policy Based Management (SPBM)
+ profile name.
type: string
volumePath:
- description: Path that identifies vSphere volume vmdk
+ description: Path that identifies vSphere volume
+ vmdk
type: string
required:
- volumePath
@@ -1120,12 +1834,15 @@
- name
x-kubernetes-list-type: map
busyBoxImage:
- description: ContainerImage defines the fields needed for a Docker repository image. The format here matches the predominant format used in Helm charts.
+ description: ContainerImage defines the fields needed for a Docker
+ repository image. The format here matches the predominant format
+ used in Helm charts.
properties:
imagePullSecret:
type: string
pullPolicy:
- description: PullPolicy describes a policy for if/when to pull a container image
+ description: PullPolicy describes a policy for if/when to pull
+ a container image
type: string
repository:
type: string
@@ -1133,10 +1850,12 @@
type: string
type: object
customSolrKubeOptions:
- description: Provide custom options for kubernetes objects created for the Solr Cloud.
+ description: Provide custom options for kubernetes objects created
+ for the Solr Cloud.
properties:
commonServiceOptions:
- description: CommonServiceOptions defines the custom options for the common solrCloud Service.
+ description: CommonServiceOptions defines the custom options for
+ the common solrCloud Service.
properties:
annotations:
additionalProperties:
@@ -1150,7 +1869,8 @@
type: object
type: object
configMapOptions:
- description: ServiceOptions defines the custom options for the solrCloud ConfigMap.
+ description: ServiceOptions defines the custom options for the
+ solrCloud ConfigMap.
properties:
annotations:
additionalProperties:
@@ -1163,11 +1883,13 @@
description: Labels to be added for the ConfigMap.
type: object
providedConfigMap:
- description: Name of a user provided ConfigMap in the same namespace containing a custom solr.xml
+ description: Name of a user provided ConfigMap in the same
+ namespace containing a custom solr.xml
type: string
type: object
headlessServiceOptions:
- description: HeadlessServiceOptions defines the custom options for the headless solrCloud Service.
+ description: HeadlessServiceOptions defines the custom options
+ for the headless solrCloud Service.
properties:
annotations:
additionalProperties:
@@ -1181,7 +1903,8 @@
type: object
type: object
ingressOptions:
- description: IngressOptions defines the custom options for the solrCloud Ingress.
+ description: IngressOptions defines the custom options for the
+ solrCloud Ingress.
properties:
annotations:
additionalProperties:
@@ -1189,7 +1912,9 @@
description: Annotations to be added for the Ingress.
type: object
ingressClassName:
- description: IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource.
+ description: IngressClassName is the name of the IngressClass
+ cluster resource. The associated IngressClass defines which
+ controller will implement the resource.
maxLength: 63
minLength: 1
pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*'
@@ -1201,7 +1926,10 @@
type: object
type: object
nodeServiceOptions:
- description: NodeServiceOptions defines the custom options for the individual solrCloud Node services, if they are created. These services will only be created when exposing SolrNodes externally via an Ingress in the AddressabilityOptions.
+ description: NodeServiceOptions defines the custom options for
+ the individual solrCloud Node services, if they are created.
+ These services will only be created when exposing SolrNodes
+ externally via an Ingress in the AddressabilityOptions.
properties:
annotations:
additionalProperties:
@@ -1215,35 +1943,69 @@
type: object
type: object
podOptions:
- description: SolrPodOptions defines the custom options for solrCloud pods.
+ description: SolrPodOptions defines the custom options for solrCloud
+ pods.
properties:
affinity:
description: The scheduling constraints on pods.
properties:
nodeAffinity:
- description: Describes node affinity scheduling rules for the pod.
+ description: Describes node affinity scheduling rules
+ for the pod.
properties:
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.
+ 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.
items:
- 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).
+ 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).
properties:
preference:
- description: A node selector term, associated with the corresponding weight.
+ description: A node selector term, associated
+ with the corresponding weight.
properties:
matchExpressions:
- description: A list of node selector requirements by node's labels.
+ description: A list of node selector requirements
+ by node's labels.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that the
+ selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's relationship
+ to a set of values. Valid operators
+ are In, NotIn, Exists, DoesNotExist.
+ Gt, and Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -1253,18 +2015,35 @@
type: object
type: array
matchFields:
- description: A list of node selector requirements by node's fields.
+ description: A list of node selector requirements
+ by node's fields.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that the
+ selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's relationship
+ to a set of values. Valid operators
+ are In, NotIn, Exists, DoesNotExist.
+ Gt, and Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -1275,7 +2054,9 @@
type: array
type: object
weight:
- description: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
+ description: Weight associated with matching
+ the corresponding nodeSelectorTerm, in the
+ range 1-100.
format: int32
type: integer
required:
@@ -1284,26 +2065,53 @@
type: object
type: array
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.
+ 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.
properties:
nodeSelectorTerms:
- description: Required. A list of node selector terms. The terms are ORed.
+ description: Required. A list of node selector
+ terms. The terms are ORed.
items:
- 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.
+ 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.
properties:
matchExpressions:
- description: A list of node selector requirements by node's labels.
+ description: A list of node selector requirements
+ by node's labels.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that the
+ selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's relationship
+ to a set of values. Valid operators
+ are In, NotIn, Exists, DoesNotExist.
+ Gt, and Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -1313,18 +2121,35 @@
type: object
type: array
matchFields:
- description: A list of node selector requirements by node's fields.
+ description: A list of node selector requirements
+ by node's fields.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that the
+ selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's relationship
+ to a set of values. Valid operators
+ are In, NotIn, Exists, DoesNotExist.
+ Gt, and Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -1340,32 +2165,67 @@
type: object
type: object
podAffinity:
- description: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
+ description: Describes pod affinity scheduling rules (e.g.
+ co-locate this pod in the same node, zone, etc. as some
+ other pod(s)).
properties:
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 has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
+ 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 has pods which matches the corresponding
+ podAffinityTerm; the node(s) with the highest sum
+ are the most preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched WeightedPodAffinityTerm
+ fields are added per-node to find the most preferred
+ node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated with the corresponding weight.
+ description: Required. A pod affinity term,
+ associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of
+ resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The
+ requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a set
+ of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -1377,22 +2237,42 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which
+ namespaces the labelSelector applies to
+ (matches against); null or empty list
+ means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located
+ (affinity) or not co-located (anti-affinity)
+ with the pods matching the labelSelector
+ in the specified namespaces, where co-located
+ is defined as running on a node whose
+ value of the label with key topologyKey
+ matches that of any node on which any
+ of the selected pods is running. Empty
+ topologyKey is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
+ description: weight associated with matching
+ the corresponding podAffinityTerm, in the
+ range 1-100.
format: int32
type: integer
required:
@@ -1401,26 +2281,59 @@
type: object
type: array
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 a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
+ 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 a pod label update), the system may or may
+ not try to eventually evict the pod from its node.
+ When there are multiple elements, the lists of nodes
+ corresponding to each podAffinityTerm are intersected,
+ i.e. all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
+ description: Defines a set of pods (namely those
+ matching the labelSelector relative to the given
+ namespace(s)) that this pod should be co-located
+ (affinity) or not co-located (anti-affinity) with,
+ where co-located is defined as running on a node
+ whose value of the label with key <topologyKey>
+ matches that of any node on which a pod of the
+ set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of resources,
+ in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The requirements
+ are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label key
+ that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a
+ key's relationship to a set of values.
+ Valid operators are In, NotIn, Exists
+ and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -1432,16 +2345,30 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which namespaces
+ the labelSelector applies to (matches against);
+ null or empty list means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity)
+ or not co-located (anti-affinity) with the
+ pods matching the labelSelector in the specified
+ namespaces, where co-located is defined as
+ running on a node whose value of the label
+ with key topologyKey matches that of any node
+ on which any of the selected pods is running.
+ Empty topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -1449,32 +2376,67 @@
type: array
type: object
podAntiAffinity:
- description: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
+ description: Describes pod anti-affinity scheduling rules
+ (e.g. avoid putting this pod in the same node, zone,
+ etc. as some other pod(s)).
properties:
preferredDuringSchedulingIgnoredDuringExecution:
- description: The scheduler will prefer to schedule pods to nodes that satisfy the anti-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 anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
+ description: The scheduler will prefer to schedule
+ pods to nodes that satisfy the anti-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 anti-affinity
+ expressions, etc.), compute a sum by iterating through
+ the elements of this field and adding "weight" to
+ the sum if the node has pods which matches the corresponding
+ podAffinityTerm; the node(s) with the highest sum
+ are the most preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched WeightedPodAffinityTerm
+ fields are added per-node to find the most preferred
+ node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated with the corresponding weight.
+ description: Required. A pod affinity term,
+ associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of
+ resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The
+ requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a set
+ of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -1486,22 +2448,42 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which
+ namespaces the labelSelector applies to
+ (matches against); null or empty list
+ means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located
+ (affinity) or not co-located (anti-affinity)
+ with the pods matching the labelSelector
+ in the specified namespaces, where co-located
+ is defined as running on a node whose
+ value of the label with key topologyKey
+ matches that of any node on which any
+ of the selected pods is running. Empty
+ topologyKey is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
+ description: weight associated with matching
+ the corresponding podAffinityTerm, in the
+ range 1-100.
format: int32
type: integer
required:
@@ -1510,26 +2492,59 @@
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
+ description: If the anti-affinity requirements specified
+ by this field are not met at scheduling time, the
+ pod will not be scheduled onto the node. If the
+ anti-affinity requirements specified by this field
+ cease to be met at some point during pod execution
+ (e.g. due to a pod label update), the system may
+ or may not try to eventually evict the pod from
+ its node. When there are multiple elements, the
+ lists of nodes corresponding to each podAffinityTerm
+ are intersected, i.e. all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
+ description: Defines a set of pods (namely those
+ matching the labelSelector relative to the given
+ namespace(s)) that this pod should be co-located
+ (affinity) or not co-located (anti-affinity) with,
+ where co-located is defined as running on a node
+ whose value of the label with key <topologyKey>
+ matches that of any node on which a pod of the
+ set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of resources,
+ in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The requirements
+ are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label key
+ that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a
+ key's relationship to a set of values.
+ Valid operators are In, NotIn, Exists
+ and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -1541,16 +2556,30 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which namespaces
+ the labelSelector applies to (matches against);
+ null or empty list means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity)
+ or not co-located (anti-affinity) with the
+ pods matching the labelSelector in the specified
+ namespaces, where co-located is defined as
+ running on a node whose value of the label
+ with key topologyKey matches that of any node
+ on which any of the selected pods is running.
+ Empty topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -1564,7 +2593,9 @@
description: Annotations to be added for pods.
type: object
defaultInitContainerResources:
- description: DefaultInitContainerResources are the resource requirements for the default init container(s) created by the Solr Operator, if any are created.
+ description: DefaultInitContainerResources are the resource
+ requirements for the default init container(s) created by
+ the Solr Operator, if any are created.
properties:
limits:
additionalProperties:
@@ -1573,7 +2604,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount of compute
+ resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -1582,22 +2614,38 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
envVars:
- description: Additional environment variables to pass to the default container.
+ description: Additional environment variables to pass to the
+ default container.
items:
- description: EnvVar represents an environment variable present in a Container.
+ description: EnvVar represents an environment variable present
+ in a Container.
properties:
name:
- description: Name of the environment variable. Must be a C_IDENTIFIER.
+ description: Name of the environment variable. Must
+ be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME) are expanded
+ using the previous 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. The $(VAR_NAME)
+ syntax can be escaped with a double $$, ie: $$(VAR_NAME).
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Defaults to
+ "".'
type: string
valueFrom:
- description: Source for the environment variable's value. Cannot be used if value is not empty.
+ description: Source for the environment variable's value.
+ Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -1606,37 +2654,53 @@
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key must be defined
+ description: Specify whether the ConfigMap or
+ its key must be defined
type: boolean
required:
- key
type: object
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.'
+ 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.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema the FieldPath
+ is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to select in
+ the specified API version.
type: string
required:
- fieldPath
type: object
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.'
+ 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.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required for volumes,
+ optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output format of
+ the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -1646,16 +2710,22 @@
- resource
type: object
secretKeyRef:
- description: Selects a key of a secret in the pod's namespace
+ description: Selects a key of a secret in the pod's
+ namespace
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select
+ from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its
+ key must be defined
type: boolean
required:
- key
@@ -1666,43 +2736,80 @@
type: object
type: array
imagePullSecrets:
- description: ImagePullSecrets to apply to the pod. These are for init/sidecarContainers in addition to the imagePullSecret defined for the solr image.
+ description: ImagePullSecrets to apply to the pod. These are
+ for init/sidecarContainers in addition to the imagePullSecret
+ defined for the solr image.
items:
- description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
+ description: LocalObjectReference contains enough information
+ to let you locate the referenced object inside the same
+ namespace.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
type: array
initContainers:
- description: Additional init containers to run in the pod. These will run along with the init container that sets up the "solr.xml".
+ description: Additional init containers to run in the pod.
+ These will run along with the init container that sets up
+ the "solr.xml".
items:
- description: A single application container that you want to run within a pod.
+ description: A single application container that you want
+ to run within a pod.
properties:
args:
- description: 'Arguments to the entrypoint. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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'
+ description: 'Arguments to the entrypoint. The docker
+ 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. The
+ $(VAR_NAME) syntax can be escaped with a double $$,
+ ie: $$(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'
items:
type: string
type: array
command:
- description: 'Entrypoint array. Not executed within a shell. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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'
+ description: 'Entrypoint array. Not executed within
+ a shell. The docker 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. The $(VAR_NAME) syntax
+ can be escaped with a double $$, ie: $$(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'
items:
type: string
type: array
env:
- description: List of environment variables to set in the container. Cannot be updated.
+ description: List of environment variables to set in
+ the container. Cannot be updated.
items:
- description: EnvVar represents an environment variable present in a Container.
+ description: EnvVar represents an environment variable
+ present in a Container.
properties:
name:
- description: Name of the environment variable. Must be a C_IDENTIFIER.
+ description: Name of the environment variable.
+ Must be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previous 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.
+ The $(VAR_NAME) syntax can be escaped with a
+ double $$, ie: $$(VAR_NAME). Escaped references
+ will never be expanded, regardless of whether
+ the variable exists or not. Defaults to "".'
type: string
valueFrom:
- description: Source for the environment variable's value. Cannot be used if value is not empty.
+ description: Source for the environment variable's
+ value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -1711,37 +2818,55 @@
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key must be defined
+ description: Specify whether the ConfigMap
+ or its key must be defined
type: boolean
required:
- key
type: object
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.'
+ 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.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema the
+ FieldPath is written in terms of, defaults
+ to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to select
+ in the specified API version.
type: string
required:
- fieldPath
type: object
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.'
+ 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.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required
+ for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output format
+ of the exposed resources, defaults to
+ "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -1751,16 +2876,23 @@
- resource
type: object
secretKeyRef:
- description: Selects a key of a secret in the pod's namespace
+ description: Selects a key of a secret in
+ the pod's namespace
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to
+ select from. Must be a valid secret
+ key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret
+ or its key must be defined
type: boolean
required:
- key
@@ -1771,66 +2903,112 @@
type: object
type: array
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.
+ 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.
items:
- description: EnvFromSource represents the source of a set of ConfigMaps
+ description: EnvFromSource represents the source of
+ a set of ConfigMaps
properties:
configMapRef:
description: The ConfigMap to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap must be defined
+ description: Specify whether the ConfigMap
+ must be defined
type: boolean
type: object
prefix:
- description: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ description: An optional identifier to prepend
+ to each key in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
description: The Secret to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret must be defined
+ description: Specify whether the Secret must
+ be defined
type: boolean
type: object
type: object
type: array
image:
- description: 'Docker 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.'
+ description: 'Docker 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.'
type: string
imagePullPolicy:
- description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
+ description: 'Image pull policy. One of Always, Never,
+ IfNotPresent. Defaults to Always if :latest tag is
+ specified, or IfNotPresent otherwise. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
+ description: Actions that the management system should
+ take in response to container lifecycle events. Cannot
+ be updated.
properties:
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following
+ should be specified. Exec specifies the action
+ to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
+ "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the
+ request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1844,58 +3022,99 @@
type: object
type: array
path:
- description: Path to access on the HTTP server.
+ description: Path to access on the HTTP
+ server.
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action
+ involving a TCP port. TCP hooks not yet supported
+ TODO: implement a realistic TCP lifecycle
+ hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
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 reason for termination is passed to the handler. The Pod''s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period. 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'
+ 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 reason for termination is passed
+ to the handler. The Pod''s termination grace period
+ countdown begins before the PreStop hooked is
+ executed. Regardless of the outcome of the handler,
+ the container will eventually terminate within
+ the Pod''s termination grace period. 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following
+ should be specified. Exec specifies the action
+ to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
+ "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the
+ request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1909,31 +3128,43 @@
type: object
type: array
path:
- description: Path to access on the HTTP server.
+ description: Path to access on the HTTP
+ server.
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action
+ involving a TCP port. TCP hooks not yet supported
+ TODO: implement a realistic TCP lifecycle
+ hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
@@ -1941,31 +3172,49 @@
type: object
type: object
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1985,71 +3234,109 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
name:
- description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
+ description: Name of the container specified as a DNS_LABEL.
+ Each container in a pod must have a unique name (DNS_LABEL).
+ Cannot be updated.
type: string
ports:
- description: List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. Cannot be updated.
+ description: List of ports to expose from the container.
+ Exposing a port here gives the system additional information
+ about the network connections a container uses, but
+ is primarily informational. 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. Cannot be updated.
items:
- description: ContainerPort represents a network port in a single container.
+ description: ContainerPort represents a network port
+ in a single container.
properties:
containerPort:
- description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's
+ IP address. This must be a valid port number,
+ 0 < x < 65536.
format: int32
type: integer
hostIP:
- description: What host IP to bind the external port to.
+ description: What host IP to bind the external
+ port to.
type: string
hostPort:
- description: 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 do not need this.
+ description: 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
+ do not need this.
format: int32
type: integer
name:
- description: 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.
+ description: 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.
type: string
protocol:
default: TCP
- description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP,
+ or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -2060,31 +3347,49 @@
- protocol
x-kubernetes-list-type: map
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2104,48 +3409,66 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
resources:
- description: 'Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Compute Resources required by this container.
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
properties:
limits:
additionalProperties:
@@ -2154,7 +3477,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -2163,119 +3487,221 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
securityContext:
- description: 'Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
+ description: 'Security options the pod should run with.
+ More info: https://kubernetes.io/docs/concepts/policy/security-context/
+ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: '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'
+ description: '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'
type: boolean
capabilities:
- description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
+ description: The capabilities to add/drop when running
+ containers. Defaults to the default set of capabilities
+ granted by the container runtime.
properties:
add:
description: Added capabilities
items:
- description: Capability represent POSIX capabilities type
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
drop:
description: Removed capabilities
items:
- description: Capability represent POSIX capabilities type
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
type: object
privileged:
- description: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
+ description: Run container in privileged mode. Processes
+ in privileged containers are essentially equivalent
+ to root on the host. Defaults to false.
type: boolean
procMount:
- description: 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.
+ description: 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.
type: string
readOnlyRootFilesystem:
- description: Whether this container has a read-only root filesystem. Default is false.
+ description: Whether this container has a read-only
+ root filesystem. Default is false.
type: boolean
runAsGroup:
- description: 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.
+ description: 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.
format: int64
type: integer
runAsNonRoot:
- description: 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.
+ description: 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.
type: boolean
runAsUser:
- description: 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.
+ description: 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.
format: int64
type: integer
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.
+ 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.
properties:
level:
- description: Level is SELinux level label that applies to the container.
+ description: Level is SELinux level label that
+ applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies to the container.
+ description: Role is a SELinux role label that
+ applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies to the container.
+ description: Type is a SELinux type label that
+ applies to the container.
type: string
user:
- description: User is a SELinux user label that applies to the container.
+ description: User is a SELinux user label that
+ applies to the container.
type: string
type: object
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.
+ 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.
properties:
localhostProfile:
- description: 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 only be set if type is "Localhost".
+ description: 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 only be set if type is "Localhost".
type: string
type:
- description: "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."
+ description: "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."
type: string
required:
- type
type: object
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.
+ 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.
properties:
gmsaCredentialSpec:
- description: 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.
+ description: 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.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name
+ of the GMSA credential spec to use.
type: string
runAsUserName:
- description: 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.
+ description: 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.
type: string
type: object
type: object
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2295,71 +3721,124 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
stdin:
- description: 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.
+ description: 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.
type: boolean
stdinOnce:
- description: 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
+ description: 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
type: boolean
terminationMessagePath:
- description: 'Optional: Path at which the file to which the container''s termination message will be written is mounted into the container''s filesystem. 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.'
+ description: 'Optional: Path at which the file to which
+ the container''s termination message will be written
+ is mounted into the container''s filesystem. 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.'
type: string
terminationMessagePolicy:
- description: 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.
+ description: 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.
type: string
tty:
- description: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be true.
+ Default is false.
type: boolean
volumeDevices:
- description: volumeDevices is the list of block devices to be used by the container.
+ description: volumeDevices is the list of block devices
+ to be used by the container.
items:
- description: volumeDevice describes a mapping of a raw block device within a container.
+ description: volumeDevice describes a mapping of a
+ raw block device within a container.
properties:
devicePath:
- description: devicePath is the path inside of the container that the device will be mapped to.
+ description: devicePath is the path inside of
+ the container that the device will be mapped
+ to.
type: string
name:
- description: name must match the name of a persistentVolumeClaim in the pod
+ description: name must match the name of a persistentVolumeClaim
+ in the pod
type: string
required:
- devicePath
@@ -2367,27 +3846,44 @@
type: object
type: array
volumeMounts:
- description: Pod volumes to mount into the container's filesystem. Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
- description: VolumeMount describes a mounting of a Volume within a container.
+ description: VolumeMount describes a mounting of a
+ Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume should be mounted. Must not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: 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.
+ description: 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.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which
+ the container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: 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.
+ description: 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.
type: string
required:
- mountPath
@@ -2395,7 +3891,10 @@
type: object
type: array
workingDir:
- description: 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.
+ description: 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.
type: string
required:
- name
@@ -2410,27 +3909,45 @@
description: Lifecycle for the main container
properties:
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request to
+ perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2450,52 +3967,85 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the
+ host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to,
+ defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
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 reason for termination is passed to the handler. The Pod''s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period. 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'
+ 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 reason for termination
+ is passed to the handler. The Pod''s termination grace
+ period countdown begins before the PreStop hooked is
+ executed. Regardless of the outcome of the handler,
+ the container will eventually terminate within the Pod''s
+ termination grace period. 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request to
+ perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2515,25 +4065,33 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the
+ host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to,
+ defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
@@ -2544,28 +4102,42 @@
description: Liveness probe parameters
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe
+ to be considered failed after having succeeded. Defaults
+ to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults to
+ the pod IP. You probably want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2585,43 +4157,59 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host.
+ Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe.
+ Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults
+ to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
@@ -2631,64 +4219,122 @@
description: Node Selector to be added for the StatefulSet.
type: object
podSecurityContext:
- description: PodSecurityContext is the security context for the pod.
+ description: PodSecurityContext is the security context for
+ the pod.
properties:
fsGroup:
- description: "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume."
+ description: "A special supplemental group that applies
+ to all containers in a pod. Some volume types allow
+ the Kubelet to change the ownership of that volume to
+ be owned by the pod: \n 1. The owning GID will be the
+ FSGroup 2. The setgid bit is set (new files created
+ in the volume will be owned by FSGroup) 3. The permission
+ bits are OR'd with rw-rw---- \n If unset, the Kubelet
+ will not modify the ownership and permissions of any
+ volume."
format: int64
type: integer
fsGroupChangePolicy:
- description: 'fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.'
+ description: 'fsGroupChangePolicy defines behavior of
+ changing ownership and permission of the volume before
+ being exposed inside Pod. This field will only apply
+ to volume types which support fsGroup based ownership(and
+ permissions). It will have no effect on ephemeral volume
+ types such as: secret, configmaps and emptydir. Valid
+ values are "OnRootMismatch" and "Always". If not specified,
+ "Always" is used.'
type: string
runAsGroup:
- description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The GID to run the entrypoint of the container
+ process. Uses runtime default if unset. May also be
+ set in SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container.
format: int64
type: integer
runAsNonRoot:
- description: 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 SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: 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 SecurityContext. If set
+ in both SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The UID to run the entrypoint of the container
+ process. Defaults to user specified in image metadata
+ if unspecified. May also be set in SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence
+ for that container.
format: int64
type: integer
seLinuxOptions:
- description: The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The SELinux context to be applied to all
+ containers. If unspecified, the container runtime will
+ allocate a random SELinux context for each container. May
+ also be set in SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container.
properties:
level:
- description: Level is SELinux level label that applies to the container.
+ description: Level is SELinux level label that applies
+ to the container.
type: string
role:
- description: Role is a SELinux role label that applies to the container.
+ description: Role is a SELinux role label that applies
+ to the container.
type: string
type:
- description: Type is a SELinux type label that applies to the container.
+ description: Type is a SELinux type label that applies
+ to the container.
type: string
user:
- description: User is a SELinux user label that applies to the container.
+ description: User is a SELinux user label that applies
+ to the container.
type: string
type: object
seccompProfile:
- description: The seccomp options to use by the containers in this pod.
+ description: The seccomp options to use by the containers
+ in this pod.
properties:
localhostProfile:
- description: 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 only be set if type is "Localhost".
+ description: 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 only be
+ set if type is "Localhost".
type: string
type:
- description: "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."
+ description: "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."
type: string
required:
- type
type: object
supplementalGroups:
- description: A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.
+ description: A list of groups applied to the first process
+ run in each container, in addition to the container's
+ primary GID. If unspecified, no groups will be added
+ to any container.
items:
format: int64
type: integer
type: array
sysctls:
- description: Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.
+ description: Sysctls hold a list of namespaced sysctls
+ used for the pod. Pods with unsupported sysctls (by
+ the container runtime) might fail to launch.
items:
- description: Sysctl defines a kernel parameter to be set
+ description: Sysctl defines a kernel parameter to be
+ set
properties:
name:
description: Name of a property to set
@@ -2702,16 +4348,29 @@
type: object
type: array
windowsOptions:
- description: The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The Windows specific settings applied to
+ all containers. If unspecified, the options within a
+ container's SecurityContext will be used. If set in
+ both SecurityContext and PodSecurityContext, the value
+ specified in SecurityContext takes precedence.
properties:
gmsaCredentialSpec:
- description: 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.
+ description: 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.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name of
+ the GMSA credential spec to use.
type: string
runAsUserName:
- description: 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.
+ description: 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.
type: string
type: object
type: object
@@ -2722,28 +4381,42 @@
description: Readiness probe parameters
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe
+ to be considered failed after having succeeded. Defaults
+ to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults to
+ the pod IP. You probably want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2763,48 +4436,65 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host.
+ Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe.
+ Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults
+ to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
resources:
- description: Resources is the resource requirements for the default container.
+ description: Resources is the resource requirements for the
+ default container.
properties:
limits:
additionalProperties:
@@ -2813,7 +4503,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount of compute
+ resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -2822,40 +4513,75 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
serviceAccountName:
description: Optional Service Account to run the pod under.
type: string
sidecarContainers:
- description: Sidecar containers to run in the pod. These are in addition to the Solr Container
+ description: Sidecar containers to run in the pod. These are
+ in addition to the Solr Container
items:
- description: A single application container that you want to run within a pod.
+ description: A single application container that you want
+ to run within a pod.
properties:
args:
- description: 'Arguments to the entrypoint. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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'
+ description: 'Arguments to the entrypoint. The docker
+ 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. The
+ $(VAR_NAME) syntax can be escaped with a double $$,
+ ie: $$(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'
items:
type: string
type: array
command:
- description: 'Entrypoint array. Not executed within a shell. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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'
+ description: 'Entrypoint array. Not executed within
+ a shell. The docker 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. The $(VAR_NAME) syntax
+ can be escaped with a double $$, ie: $$(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'
items:
type: string
type: array
env:
- description: List of environment variables to set in the container. Cannot be updated.
+ description: List of environment variables to set in
+ the container. Cannot be updated.
items:
- description: EnvVar represents an environment variable present in a Container.
+ description: EnvVar represents an environment variable
+ present in a Container.
properties:
name:
- description: Name of the environment variable. Must be a C_IDENTIFIER.
+ description: Name of the environment variable.
+ Must be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previous 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.
+ The $(VAR_NAME) syntax can be escaped with a
+ double $$, ie: $$(VAR_NAME). Escaped references
+ will never be expanded, regardless of whether
+ the variable exists or not. Defaults to "".'
type: string
valueFrom:
- description: Source for the environment variable's value. Cannot be used if value is not empty.
+ description: Source for the environment variable's
+ value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -2864,37 +4590,55 @@
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key must be defined
+ description: Specify whether the ConfigMap
+ or its key must be defined
type: boolean
required:
- key
type: object
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.'
+ 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.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema the
+ FieldPath is written in terms of, defaults
+ to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to select
+ in the specified API version.
type: string
required:
- fieldPath
type: object
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.'
+ 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.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required
+ for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output format
+ of the exposed resources, defaults to
+ "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -2904,16 +4648,23 @@
- resource
type: object
secretKeyRef:
- description: Selects a key of a secret in the pod's namespace
+ description: Selects a key of a secret in
+ the pod's namespace
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to
+ select from. Must be a valid secret
+ key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret
+ or its key must be defined
type: boolean
required:
- key
@@ -2924,66 +4675,112 @@
type: object
type: array
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.
+ 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.
items:
- description: EnvFromSource represents the source of a set of ConfigMaps
+ description: EnvFromSource represents the source of
+ a set of ConfigMaps
properties:
configMapRef:
description: The ConfigMap to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap must be defined
+ description: Specify whether the ConfigMap
+ must be defined
type: boolean
type: object
prefix:
- description: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ description: An optional identifier to prepend
+ to each key in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
description: The Secret to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret must be defined
+ description: Specify whether the Secret must
+ be defined
type: boolean
type: object
type: object
type: array
image:
- description: 'Docker 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.'
+ description: 'Docker 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.'
type: string
imagePullPolicy:
- description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
+ description: 'Image pull policy. One of Always, Never,
+ IfNotPresent. Defaults to Always if :latest tag is
+ specified, or IfNotPresent otherwise. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
+ description: Actions that the management system should
+ take in response to container lifecycle events. Cannot
+ be updated.
properties:
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following
+ should be specified. Exec specifies the action
+ to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
+ "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the
+ request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2997,58 +4794,99 @@
type: object
type: array
path:
- description: Path to access on the HTTP server.
+ description: Path to access on the HTTP
+ server.
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action
+ involving a TCP port. TCP hooks not yet supported
+ TODO: implement a realistic TCP lifecycle
+ hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
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 reason for termination is passed to the handler. The Pod''s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period. 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'
+ 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 reason for termination is passed
+ to the handler. The Pod''s termination grace period
+ countdown begins before the PreStop hooked is
+ executed. Regardless of the outcome of the handler,
+ the container will eventually terminate within
+ the Pod''s termination grace period. 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following
+ should be specified. Exec specifies the action
+ to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
+ "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the
+ request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3062,31 +4900,43 @@
type: object
type: array
path:
- description: Path to access on the HTTP server.
+ description: Path to access on the HTTP
+ server.
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action
+ involving a TCP port. TCP hooks not yet supported
+ TODO: implement a realistic TCP lifecycle
+ hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
@@ -3094,31 +4944,49 @@
type: object
type: object
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3138,71 +5006,109 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
name:
- description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
+ description: Name of the container specified as a DNS_LABEL.
+ Each container in a pod must have a unique name (DNS_LABEL).
+ Cannot be updated.
type: string
ports:
- description: List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. Cannot be updated.
+ description: List of ports to expose from the container.
+ Exposing a port here gives the system additional information
+ about the network connections a container uses, but
+ is primarily informational. 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. Cannot be updated.
items:
- description: ContainerPort represents a network port in a single container.
+ description: ContainerPort represents a network port
+ in a single container.
properties:
containerPort:
- description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's
+ IP address. This must be a valid port number,
+ 0 < x < 65536.
format: int32
type: integer
hostIP:
- description: What host IP to bind the external port to.
+ description: What host IP to bind the external
+ port to.
type: string
hostPort:
- description: 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 do not need this.
+ description: 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
+ do not need this.
format: int32
type: integer
name:
- description: 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.
+ description: 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.
type: string
protocol:
default: TCP
- description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP,
+ or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -3213,31 +5119,49 @@
- protocol
x-kubernetes-list-type: map
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3257,48 +5181,66 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
resources:
- description: 'Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Compute Resources required by this container.
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
properties:
limits:
additionalProperties:
@@ -3307,7 +5249,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -3316,119 +5259,221 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
securityContext:
- description: 'Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
+ description: 'Security options the pod should run with.
+ More info: https://kubernetes.io/docs/concepts/policy/security-context/
+ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: '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'
+ description: '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'
type: boolean
capabilities:
- description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
+ description: The capabilities to add/drop when running
+ containers. Defaults to the default set of capabilities
+ granted by the container runtime.
properties:
add:
description: Added capabilities
items:
- description: Capability represent POSIX capabilities type
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
drop:
description: Removed capabilities
items:
- description: Capability represent POSIX capabilities type
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
type: object
privileged:
- description: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
+ description: Run container in privileged mode. Processes
+ in privileged containers are essentially equivalent
+ to root on the host. Defaults to false.
type: boolean
procMount:
- description: 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.
+ description: 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.
type: string
readOnlyRootFilesystem:
- description: Whether this container has a read-only root filesystem. Default is false.
+ description: Whether this container has a read-only
+ root filesystem. Default is false.
type: boolean
runAsGroup:
- description: 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.
+ description: 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.
format: int64
type: integer
runAsNonRoot:
- description: 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.
+ description: 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.
type: boolean
runAsUser:
- description: 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.
+ description: 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.
format: int64
type: integer
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.
+ 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.
properties:
level:
- description: Level is SELinux level label that applies to the container.
+ description: Level is SELinux level label that
+ applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies to the container.
+ description: Role is a SELinux role label that
+ applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies to the container.
+ description: Type is a SELinux type label that
+ applies to the container.
type: string
user:
- description: User is a SELinux user label that applies to the container.
+ description: User is a SELinux user label that
+ applies to the container.
type: string
type: object
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.
+ 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.
properties:
localhostProfile:
- description: 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 only be set if type is "Localhost".
+ description: 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 only be set if type is "Localhost".
type: string
type:
- description: "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."
+ description: "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."
type: string
required:
- type
type: object
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.
+ 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.
properties:
gmsaCredentialSpec:
- description: 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.
+ description: 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.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name
+ of the GMSA credential spec to use.
type: string
runAsUserName:
- description: 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.
+ description: 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.
type: string
type: object
type: object
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3448,71 +5493,124 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
stdin:
- description: 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.
+ description: 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.
type: boolean
stdinOnce:
- description: 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
+ description: 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
type: boolean
terminationMessagePath:
- description: 'Optional: Path at which the file to which the container''s termination message will be written is mounted into the container''s filesystem. 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.'
+ description: 'Optional: Path at which the file to which
+ the container''s termination message will be written
+ is mounted into the container''s filesystem. 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.'
type: string
terminationMessagePolicy:
- description: 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.
+ description: 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.
type: string
tty:
- description: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be true.
+ Default is false.
type: boolean
volumeDevices:
- description: volumeDevices is the list of block devices to be used by the container.
+ description: volumeDevices is the list of block devices
+ to be used by the container.
items:
- description: volumeDevice describes a mapping of a raw block device within a container.
+ description: volumeDevice describes a mapping of a
+ raw block device within a container.
properties:
devicePath:
- description: devicePath is the path inside of the container that the device will be mapped to.
+ description: devicePath is the path inside of
+ the container that the device will be mapped
+ to.
type: string
name:
- description: name must match the name of a persistentVolumeClaim in the pod
+ description: name must match the name of a persistentVolumeClaim
+ in the pod
type: string
required:
- devicePath
@@ -3520,27 +5618,44 @@
type: object
type: array
volumeMounts:
- description: Pod volumes to mount into the container's filesystem. Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
- description: VolumeMount describes a mounting of a Volume within a container.
+ description: VolumeMount describes a mounting of a
+ Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume should be mounted. Must not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: 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.
+ description: 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.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which
+ the container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: 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.
+ description: 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.
type: string
required:
- mountPath
@@ -3548,7 +5663,10 @@
type: object
type: array
workingDir:
- description: 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.
+ description: 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.
type: string
required:
- name
@@ -3558,28 +5676,42 @@
description: Startup probe parameters
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe
+ to be considered failed after having succeeded. Defaults
+ to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults to
+ the pod IP. You probably want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3599,95 +5731,149 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host.
+ Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe.
+ Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults
+ to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs to terminate gracefully.
+ description: Optional duration in seconds the pod needs to
+ terminate gracefully.
format: int64
minimum: 10
type: integer
tolerations:
description: Tolerations to be added for the StatefulSet.
items:
- description: The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
+ description: The pod this Toleration is attached to tolerates
+ any taint that matches the triple <key,value,effect> using
+ the matching operator <operator>.
properties:
effect:
- description: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
+ description: Effect indicates the taint effect to match.
+ Empty means match all taint effects. When specified,
+ allowed values are NoSchedule, PreferNoSchedule and
+ NoExecute.
type: string
key:
- description: Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
+ description: Key is the taint key that the toleration
+ applies to. Empty means match all taint keys. If the
+ key is empty, operator must be Exists; this combination
+ means to match all values and all keys.
type: string
operator:
- description: Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
+ description: Operator represents a key's relationship
+ to the value. Valid operators are Exists and Equal.
+ Defaults to Equal. Exists is equivalent to wildcard
+ for value, so that a pod can tolerate all taints of
+ a particular category.
type: string
tolerationSeconds:
- description: TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
+ description: TolerationSeconds represents the period
+ of time the toleration (which must be of effect NoExecute,
+ otherwise this field is ignored) tolerates the taint.
+ By default, it is not set, which means tolerate the
+ taint forever (do not evict). Zero and negative values
+ will be treated as 0 (evict immediately) by the system.
format: int64
type: integer
value:
- description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
+ description: Value is the taint value the toleration
+ matches to. If the operator is Exists, the value should
+ be empty, otherwise just a regular string.
type: string
type: object
type: array
topologySpreadConstraints:
- description: "Optional PodSpreadTopologyConstraints to use when scheduling pods. More information here: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ \n Note: There is no need to provide a \"labelSelector\", as the operator will inject the labels for you if not provided."
+ description: "Optional PodSpreadTopologyConstraints to use
+ when scheduling pods. More information here: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
+ \n Note: There is no need to provide a \"labelSelector\",
+ as the operator will inject the labels for you if not provided."
items:
- description: TopologySpreadConstraint specifies how to spread matching pods among the given topology.
+ description: TopologySpreadConstraint specifies how to spread
+ matching pods among the given topology.
properties:
labelSelector:
- description: LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
+ description: LabelSelector is used to find matching
+ pods. Pods that match this label selector are counted
+ to determine the number of pods in their corresponding
+ topology domain.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label
+ selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement is a
+ selector that contains values, a key, and an
+ operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label key that the
+ selector applies to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship
+ to a set of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -3699,18 +5885,59 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
maxSkew:
- description: 'MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It''s a required field. Default value is 1 and 0 is not allowed.'
+ description: 'MaxSkew describes the degree to which
+ pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`,
+ it is the maximum permitted difference between the
+ number of matching pods in the target topology and
+ the global minimum. For example, in a 3-zone cluster,
+ MaxSkew is set to 1, and pods with the same labelSelector
+ spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | |
+ - if MaxSkew is 1, incoming pod can only be scheduled
+ to zone3 to become 1/1/1; scheduling it onto zone1(zone2)
+ would make the ActualSkew(2-0) on zone1(zone2) violate
+ MaxSkew(1). - if MaxSkew is 2, incoming pod can be
+ scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`,
+ it is used to give higher precedence to topologies
+ that satisfy it. It''s a required field. Default value
+ is 1 and 0 is not allowed.'
format: int32
type: integer
topologyKey:
- description: TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. It's a required field.
+ description: TopologyKey is the key of node labels.
+ Nodes that have a label with this key and identical
+ values are considered to be in the same topology.
+ We consider each <key, value> as a "bucket", and try
+ to put balanced number of pods into each bucket. It's
+ a required field.
type: string
whenUnsatisfiable:
- description: 'WhenUnsatisfiable indicates how to deal with a pod if it doesn''t satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won''t make it *more* imbalanced. It''s a required field.'
+ description: 'WhenUnsatisfiable indicates how to deal
+ with a pod if it doesn''t satisfy the spread constraint.
+ - DoNotSchedule (default) tells the scheduler not
+ to schedule it. - ScheduleAnyway tells the scheduler
+ to schedule the pod in any location, but giving
+ higher precedence to topologies that would help reduce
+ the skew. A constraint is considered "Unsatisfiable"
+ for an incoming pod if and only if every possible
+ node assigment for that pod would violate "MaxSkew"
+ on some topology. For example, in a 3-zone cluster,
+ MaxSkew is set to 1, and pods with the same labelSelector
+ spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P
+ | P | P | If WhenUnsatisfiable is set to DoNotSchedule,
+ incoming pod can only be scheduled to zone2(zone3)
+ to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3)
+ satisfies MaxSkew(1). In other words, the cluster
+ can still be imbalanced, but scheduler won''t make
+ it *more* imbalanced. It''s a required field.'
type: string
required:
- maxSkew
@@ -3723,30 +5950,49 @@
- whenUnsatisfiable
x-kubernetes-list-type: map
volumes:
- description: Additional non-data volumes to load into the default container.
+ description: Additional non-data volumes to load into the
+ default container.
items:
- description: AdditionalVolume provides information on additional volumes that should be loaded into pods
+ description: AdditionalVolume provides information on additional
+ volumes that should be loaded into pods
properties:
defaultContainerMount:
- description: DefaultContainerMount defines how to mount this volume into the default container. If this volume is to be used only with sidecar or non-default init containers, then this option is not necessary.
+ description: DefaultContainerMount defines how to mount
+ this volume into the default container. If this volume
+ is to be used only with sidecar or non-default init
+ containers, then this option is not necessary.
properties:
mountPath:
- description: Path within the container at which the volume should be mounted. Must not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: 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.
+ description: 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.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which the
+ container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: 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.
+ description: 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.
type: string
required:
- mountPath
@@ -3756,60 +6002,100 @@
description: Name of the volume
type: string
source:
- description: Source is the source of the Volume to be loaded into the solrCloud Pod
+ description: Source is the source of the Volume to be
+ loaded into the solrCloud Pod
properties:
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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 TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume
+ that you want to mount. Tip: Ensure that the
+ filesystem 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
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: '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).'
+ description: '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).'
format: int32
type: integer
readOnly:
- description: 'Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'Specify "true" to force and set
+ the ReadOnly property in VolumeMounts to "true".
+ If omitted, the default is "false". More info:
+ https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: boolean
volumeID:
- description: 'Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'Unique ID of the persistent disk
+ resource in AWS (Amazon EBS volume). More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: string
required:
- volumeID
type: object
azureDisk:
- description: AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+ description: AzureDisk represents an Azure Data
+ Disk mount on the host and bind mount to the pod.
properties:
cachingMode:
- description: 'Host Caching mode: None, Read Only, Read Write.'
+ description: 'Host Caching mode: None, Read
+ Only, Read Write.'
type: string
diskName:
- description: The Name of the data disk in the blob storage
+ description: The Name of the data disk in the
+ blob storage
type: string
diskURI:
- description: The URI the data disk in the blob storage
+ description: The URI the data disk in the blob
+ storage
type: string
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
kind:
- description: 'Expected values 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'
+ description: 'Expected values 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'
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
required:
- diskName
- diskURI
type: object
azureFile:
- description: AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
+ description: AzureFile represents an Azure File
+ Service mount on the host and bind mount to the
+ pod.
properties:
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretName:
- description: the name of secret that contains Azure Storage Account Name and Key
+ description: the name of secret that contains
+ Azure Storage Account Name and Key
type: string
shareName:
description: Share Name
@@ -3819,78 +6105,142 @@
- shareName
type: object
cephfs:
- description: CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
+ description: CephFS represents a Ceph FS mount on
+ the host that shares a pod's lifetime
properties:
monitors:
- description: 'Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'Required: Monitors is a collection
+ of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
items:
type: string
type: array
path:
- description: 'Optional: Used as the mounted root, rather than the full Ceph tree, default is /'
+ description: 'Optional: Used as the mounted
+ root, rather than the full Ceph tree, default
+ is /'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
secretFile:
- description: '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'
+ description: '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'
type: string
secretRef:
- description: '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'
+ description: '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'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
user:
- description: 'Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'Optional: User is the rados user
+ name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
required:
- monitors
type: object
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'
+ description: 'Cinder represents a cinder volume
+ attached and mounted on kubelets host machine.
+ More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
properties:
fsType:
- description: 'Filesystem type to mount. Must be a filesystem 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'
+ description: 'Filesystem type to mount. Must
+ be a filesystem 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'
type: string
readOnly:
- description: 'Optional: 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'
+ description: 'Optional: 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'
type: boolean
secretRef:
- description: 'Optional: points to a secret object containing parameters used to connect to OpenStack.'
+ description: 'Optional: points to a secret object
+ containing parameters used to connect to OpenStack.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
volumeID:
- description: 'volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'volume id used to identify the
+ volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
required:
- volumeID
type: object
configMap:
- description: ConfigMap represents a configMap that should populate this volume
+ description: ConfigMap represents a configMap that
+ should populate this volume
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: 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 '..'.
+ description: 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 '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to a path within
+ a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -3898,85 +6248,156 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its keys must be defined
+ description: Specify whether the ConfigMap or
+ its keys must be defined
type: boolean
type: object
csi:
- description: CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
+ description: CSI (Container Storage Interface) represents
+ ephemeral storage that is handled by certain external
+ CSI drivers (Beta feature).
properties:
driver:
- description: Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
+ description: Driver is the name of the CSI driver
+ that handles this volume. Consult with your
+ admin for the correct name as registered in
+ the cluster.
type: string
fsType:
- description: Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
+ description: Filesystem type to mount. Ex. "ext4",
+ "xfs", "ntfs". If not provided, the empty
+ value is passed to the associated CSI driver
+ which will determine the default filesystem
+ to apply.
type: string
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.
+ 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.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
readOnly:
- description: Specifies a read-only configuration for the volume. Defaults to false (read/write).
+ description: Specifies a read-only configuration
+ for the volume. Defaults to false (read/write).
type: boolean
volumeAttributes:
additionalProperties:
type: string
- description: VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
+ description: VolumeAttributes stores driver-specific
+ properties that are passed to the CSI driver.
+ Consult your driver's documentation for supported
+ values.
type: object
required:
- driver
type: object
downwardAPI:
- description: DownwardAPI represents downward API about the pod that should populate this volume
+ description: DownwardAPI represents downward API
+ about the pod that should populate this volume
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: Items is a list of downward API volume file
+ description: Items is a list of downward API
+ volume file
items:
- description: DownwardAPIVolumeFile represents information to create the file containing the pod field
+ description: DownwardAPIVolumeFile represents
+ information to create the file containing
+ the pod field
properties:
fieldRef:
- description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
+ description: 'Required: Selects a field
+ of the pod: only annotations, labels,
+ name and namespace are supported.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema
+ the FieldPath is written in terms
+ of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to
+ select in the specified API version.
type: string
required:
- fieldPath
type: object
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative path name 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 ''..'''
+ description: 'Required: Path is the relative
+ path name 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 ''..'''
type: string
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.'
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ requests.cpu and requests.memory) are
+ currently supported.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required
+ for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output
+ format of the exposed resources,
+ defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
- description: 'Required: resource to select'
+ description: 'Required: resource to
+ select'
type: string
required:
- resource
@@ -3987,57 +6408,147 @@
type: array
type: object
emptyDir:
- description: 'EmptyDir represents a temporary directory that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
+ description: 'EmptyDir represents a temporary directory
+ that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
properties:
medium:
- description: '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'
+ description: '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'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
+ description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: "Ephemeral represents a volume that is handled by a cluster storage driver (Alpha feature). 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."
+ description: "Ephemeral represents a volume that
+ is handled by a cluster storage driver (Alpha
+ feature). 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."
properties:
readOnly:
- description: Specifies a read-only configuration for the volume. Defaults to false (read/write).
+ description: Specifies a read-only configuration
+ for the volume. Defaults to false (read/write).
type: boolean
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). \n 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. \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."
+ 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).
+ \n 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. \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."
properties:
metadata:
- description: 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.
+ description: 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.
type: object
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.
+ 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.
properties:
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'
+ description: 'AccessModes contains the
+ desired access modes the volume should
+ have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. 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.'
+ description: 'This field can be used
+ to specify either: * An existing VolumeSnapshot
+ object (snapshot.storage.k8s.io/VolumeSnapshot)
+ * An existing PVC (PersistentVolumeClaim)
+ * An existing custom resource that
+ implements data population (Alpha)
+ In order to use custom resource types
+ that implement data population, the
+ AnyVolumeDataSource feature gate must
+ be enabled. 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.'
properties:
apiGroup:
- description: 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.
+ description: 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.
type: string
kind:
- description: Kind is the type of resource being referenced
+ description: Kind is the type of
+ resource being referenced
type: string
name:
- description: Name is the name of resource being referenced
+ description: Name is the name of
+ resource being referenced
type: string
required:
- kind
- name
type: object
resources:
- description: 'Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'Resources represents the
+ minimum resources the volume should
+ have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
@@ -4046,7 +6557,9 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the
+ maximum amount of compute resources
+ allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -4055,25 +6568,54 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
selector:
- description: A label query over volumes to consider for binding.
+ description: A label query over volumes
+ to consider for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is
+ a list of label selector requirements.
+ The requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector
+ requirement is a selector that
+ contains values, a key, and
+ an operator that relates the
+ key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to
+ a set of values. Valid operators
+ are In, NotIn, Exists and
+ DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -4085,17 +6627,32 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
storageClassName:
- description: 'Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'Name of the StorageClass
+ required by the claim. More info:
+ https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
+ description: volumeMode defines what
+ type of volume is required by the
+ claim. Value of Filesystem is implied
+ when not included in claim spec.
type: string
volumeName:
- description: VolumeName is the binding reference to the PersistentVolume backing this claim.
+ description: VolumeName is the binding
+ reference to the PersistentVolume
+ backing this claim.
type: string
type: object
required:
@@ -4103,90 +6660,157 @@
type: object
type: object
fc:
- description: FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
+ description: FC represents a Fibre Channel resource
+ that is attached to a kubelet's host machine and
+ then exposed to the pod.
properties:
fsType:
- description: 'Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
lun:
description: 'Optional: FC target lun number'
format: int32
type: integer
readOnly:
- description: 'Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'Optional: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.'
type: boolean
targetWWNs:
- description: 'Optional: FC target worldwide names (WWNs)'
+ description: 'Optional: FC target worldwide
+ names (WWNs)'
items:
type: string
type: array
wwids:
- description: 'Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.'
+ description: 'Optional: FC volume world wide
+ identifiers (wwids) Either wwids or combination
+ of targetWWNs and lun must be set, but not
+ both simultaneously.'
items:
type: string
type: array
type: object
flexVolume:
- description: FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
+ description: FlexVolume represents a generic volume
+ resource that is provisioned/attached using an
+ exec based plugin.
properties:
driver:
- description: Driver is the name of the driver to use for this volume.
+ description: Driver is the name of the driver
+ to use for this volume.
type: string
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ The default filesystem depends on FlexVolume
+ script.
type: string
options:
additionalProperties:
type: string
- description: 'Optional: Extra command options if any.'
+ description: 'Optional: Extra command options
+ if any.'
type: object
readOnly:
- description: 'Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'Optional: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.'
type: boolean
secretRef:
- description: '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.'
+ description: '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.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
required:
- driver
type: object
flocker:
- description: Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
+ description: Flocker represents a Flocker volume
+ attached to a kubelet's host machine. This depends
+ on the Flocker control service being running
properties:
datasetName:
- description: Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
+ description: Name of the dataset stored as metadata
+ -> name on the dataset for Flocker should
+ be considered as deprecated
type: string
datasetUUID:
- description: UUID of the dataset. This is unique identifier of a Flocker dataset
+ description: UUID of the dataset. This is unique
+ identifier of a Flocker dataset
type: string
type: object
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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 TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume
+ that you want to mount. Tip: Ensure that the
+ filesystem 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
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: '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). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: '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). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
format: int32
type: integer
pdName:
- description: 'Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'Unique name of the PD resource
+ in GCE. Used to identify the disk in GCE.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: string
readOnly:
- description: 'ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'ReadOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: boolean
required:
- pdName
type: object
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.'
+ 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.'
properties:
directory:
- description: 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.
+ description: 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.
type: string
repository:
description: Repository URL
@@ -4198,75 +6822,121 @@
- repository
type: object
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'
+ 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'
properties:
endpoints:
- description: 'EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'EndpointsName is the endpoint
+ name that details Glusterfs topology. More
+ info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
path:
- description: 'Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'Path is the Glusterfs volume path.
+ More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
required:
- endpoints
- path
type: object
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.'
+ 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.'
properties:
path:
- description: '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'
+ description: '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'
type: string
type:
- description: 'Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
+ description: 'Type for HostPath Volume Defaults
+ to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
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'
+ 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'
properties:
chapAuthDiscovery:
- description: whether support iSCSI Discovery CHAP authentication
+ description: whether support iSCSI Discovery
+ CHAP authentication
type: boolean
chapAuthSession:
- description: whether support iSCSI Session CHAP authentication
+ description: whether support iSCSI Session CHAP
+ authentication
type: boolean
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume
+ that you want to mount. Tip: Ensure that the
+ filesystem 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#iscsi
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
initiatorName:
- description: Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
+ description: Custom iSCSI Initiator Name. If
+ initiatorName is specified with iscsiInterface
+ simultaneously, new iSCSI interface <target
+ portal>:<volume name> will be created for
+ the connection.
type: string
iqn:
description: Target iSCSI Qualified Name.
type: string
iscsiInterface:
- description: iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
+ description: iSCSI Interface Name that uses
+ an iSCSI transport. Defaults to 'default'
+ (tcp).
type: string
lun:
description: iSCSI Target Lun number.
format: int32
type: integer
portals:
- description: 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).
+ description: 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).
items:
type: string
type: array
readOnly:
- description: ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
+ description: ReadOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
type: boolean
secretRef:
- description: CHAP Secret for iSCSI target and initiator authentication
+ description: CHAP Secret for iSCSI target and
+ initiator authentication
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
targetPortal:
- description: 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).
+ description: 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).
type: string
required:
- iqn
@@ -4274,89 +6944,160 @@
- targetPortal
type: object
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'
+ 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'
properties:
path:
- description: 'Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'Path that is exported by the NFS
+ server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
server:
- description: 'Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'Server is the hostname or IP address
+ of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- path
- server
type: object
persistentVolumeClaim:
- description: 'PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'PersistentVolumeClaimVolumeSource
+ represents a reference to a PersistentVolumeClaim
+ in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
claimName:
- description: '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'
+ description: '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'
type: string
readOnly:
- description: Will force the ReadOnly setting in VolumeMounts. Default false.
+ description: Will force the ReadOnly setting
+ in VolumeMounts. Default false.
type: boolean
required:
- claimName
type: object
photonPersistentDisk:
- description: PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
+ description: PhotonPersistentDisk represents a PhotonController
+ persistent disk attached and mounted on kubelets
+ host machine
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
pdID:
- description: ID that identifies Photon Controller persistent disk
+ description: ID that identifies Photon Controller
+ persistent disk
type: string
required:
- pdID
type: object
portworxVolume:
- description: PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
+ description: PortworxVolume represents a portworx
+ volume attached and mounted on kubelets host machine
properties:
fsType:
- description: FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
+ description: FSType represents the filesystem
+ type to mount Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs". Implicitly inferred to be "ext4" if
+ unspecified.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
volumeID:
- description: VolumeID uniquely identifies a Portworx volume
+ description: VolumeID uniquely identifies a
+ Portworx volume
type: string
required:
- volumeID
type: object
projected:
- description: Items for all in one resources secrets, configmaps, and downward API
+ description: Items for all in one resources secrets,
+ configmaps, and downward API
properties:
defaultMode:
- description: 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.
+ description: 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.
format: int32
type: integer
sources:
description: list of volume projections
items:
- description: Projection that may be projected along with other supported volume types
+ description: Projection that may be projected
+ along with other supported volume types
properties:
configMap:
- description: information about the configMap data to project
+ description: information about the configMap
+ data to project
properties:
items:
- description: 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 '..'.
+ description: 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
+ '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to
+ a path within a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -4364,54 +7105,102 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent.
+ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its keys must be defined
+ description: Specify whether the ConfigMap
+ or its keys must be defined
type: boolean
type: object
downwardAPI:
- description: information about the downwardAPI data to project
+ description: information about the downwardAPI
+ data to project
properties:
items:
- description: Items is a list of DownwardAPIVolume file
+ description: Items is a list of DownwardAPIVolume
+ file
items:
- description: DownwardAPIVolumeFile represents information to create the file containing the pod field
+ description: DownwardAPIVolumeFile
+ represents information to create
+ the file containing the pod field
properties:
fieldRef:
- description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
+ description: 'Required: Selects
+ a field of the pod: only annotations,
+ labels, name and namespace
+ are supported.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of
+ the schema the FieldPath
+ is written in terms of,
+ defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the
+ field to select in the
+ specified API version.
type: string
required:
- fieldPath
type: object
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative path name 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 ''..'''
+ description: 'Required: Path
+ is the relative path name
+ 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 ''..'''
type: string
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.'
+ description: 'Selects a resource
+ of the container: only resources
+ limits and requests (limits.cpu,
+ limits.memory, requests.cpu
+ and requests.memory) are currently
+ supported.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container
+ name: required for volumes,
+ optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the
+ output format of the exposed
+ resources, defaults to
+ "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
- description: 'Required: resource to select'
+ description: 'Required:
+ resource to select'
type: string
required:
- resource
@@ -4422,22 +7211,57 @@
type: array
type: object
secret:
- description: information about the secret data to project
+ description: information about the secret
+ data to project
properties:
items:
- description: 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 '..'.
+ description: 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
+ '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to
+ a path within a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -4445,24 +7269,49 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent.
+ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret
+ or its key must be defined
type: boolean
type: object
serviceAccountToken:
- description: information about the serviceAccountToken data to project
+ description: information about the serviceAccountToken
+ data to project
properties:
audience:
- description: 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.
+ description: 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.
type: string
expirationSeconds:
- description: 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.
+ description: 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.
format: int64
type: integer
path:
- description: Path is the path relative to the mount point of the file to project the token into.
+ description: Path is the path relative
+ to the mount point of the file to
+ project the token into.
type: string
required:
- path
@@ -4471,103 +7320,159 @@
type: array
type: object
quobyte:
- description: Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
+ description: Quobyte represents a Quobyte mount
+ on the host that shares a pod's lifetime
properties:
group:
- description: Group to map volume access to Default is no group
+ description: Group to map volume access to Default
+ is no group
type: string
readOnly:
- description: ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
+ description: ReadOnly here will force the Quobyte
+ volume to be mounted with read-only permissions.
+ Defaults to false.
type: boolean
registry:
- description: 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
+ description: 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
type: string
tenant:
- description: Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ description: Tenant owning the given Quobyte
+ volume in the Backend Used with dynamically
+ provisioned Quobyte volumes, value is set
+ by the plugin
type: string
user:
- description: User to map volume access to Defaults to serivceaccount user
+ description: User to map volume access to Defaults
+ to serivceaccount user
type: string
volume:
- description: Volume is a string that references an already created Quobyte volume by name.
+ description: Volume is a string that references
+ an already created Quobyte volume by name.
type: string
required:
- registry
- volume
type: object
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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#rbd TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume
+ that you want to mount. Tip: Ensure that the
+ filesystem 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#rbd
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
image:
- description: 'The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'The rados image name. More info:
+ https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
keyring:
- description: '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'
+ description: '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'
type: string
monitors:
- description: 'A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'A collection of Ceph monitors.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
items:
type: string
type: array
pool:
- description: 'The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'The rados pool name. Default is
+ rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
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'
+ 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'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
user:
- description: 'The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'The rados user name. Default is
+ admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- image
- monitors
type: object
scaleIO:
- description: ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
+ description: ScaleIO represents a ScaleIO persistent
+ volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Default is "xfs".
type: string
gateway:
- description: The host address of the ScaleIO API Gateway.
+ description: The host address of the ScaleIO
+ API Gateway.
type: string
protectionDomain:
- description: The name of the ScaleIO Protection Domain for the configured storage.
+ description: The name of the ScaleIO Protection
+ Domain for the configured storage.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
+ description: SecretRef references to the secret
+ for ScaleIO user and other sensitive information.
+ If this is not provided, Login operation will
+ fail.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
sslEnabled:
- description: Flag to enable/disable SSL communication with Gateway, default false
+ description: Flag to enable/disable SSL communication
+ with Gateway, default false
type: boolean
storageMode:
- description: Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
+ description: Indicates whether the storage for
+ a volume should be ThickProvisioned or ThinProvisioned.
+ Default is ThinProvisioned.
type: string
storagePool:
- description: The ScaleIO Storage Pool associated with the protection domain.
+ description: The ScaleIO Storage Pool associated
+ with the protection domain.
type: string
system:
- description: The name of the storage system as configured in ScaleIO.
+ description: The name of the storage system
+ as configured in ScaleIO.
type: string
volumeName:
- description: The name of a volume already created in the ScaleIO system that is associated with this volume source.
+ description: The name of a volume already created
+ in the ScaleIO system that is associated with
+ this volume source.
type: string
required:
- gateway
@@ -4575,26 +7480,63 @@
- system
type: object
secret:
- description: 'Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'Secret represents a secret that should
+ populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: 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 '..'.
+ description: 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 '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to a path within
+ a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -4602,49 +7544,80 @@
type: object
type: array
optional:
- description: Specify whether the Secret or its keys must be defined
+ description: Specify whether the Secret or its
+ keys must be defined
type: boolean
secretName:
- description: 'Name of the secret in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'Name of the secret in the pod''s
+ namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
type: string
type: object
storageos:
- description: StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
+ description: StorageOS represents a StorageOS volume
+ attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
+ description: SecretRef specifies the secret
+ to use for obtaining the StorageOS API credentials. If
+ not specified, default values will be attempted.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
volumeName:
- description: VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
+ description: VolumeName is the human-readable
+ name of the StorageOS volume. Volume names
+ are only unique within a namespace.
type: string
volumeNamespace:
- description: 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 do not pre-exist within StorageOS will be created.
+ description: 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 do not pre-exist
+ within StorageOS will be created.
type: string
type: object
vsphereVolume:
- description: VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
+ description: VsphereVolume represents a vSphere
+ volume attached and mounted on kubelets host machine
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
storagePolicyID:
- description: Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
+ description: Storage Policy Based Management
+ (SPBM) profile ID associated with the StoragePolicyName.
type: string
storagePolicyName:
- description: Storage Policy Based Management (SPBM) profile name.
+ description: Storage Policy Based Management
+ (SPBM) profile name.
type: string
volumePath:
- description: Path that identifies vSphere volume vmdk
+ description: Path that identifies vSphere volume
+ vmdk
type: string
required:
- volumePath
@@ -4657,7 +7630,8 @@
type: array
type: object
statefulSetOptions:
- description: StatefulSetOptions defines the custom options for the solrCloud StatefulSet.
+ description: StatefulSetOptions defines the custom options for
+ the solrCloud StatefulSet.
properties:
annotations:
additionalProperties:
@@ -4670,7 +7644,11 @@
description: Labels to be added for the StatefulSet.
type: object
podManagementPolicy:
- description: PodManagementPolicy defines the policy for creating pods under a stateful set. Override the default value of Parallel. This cannot be updated on an existing StatefulSet, the StatefulSet must be deleted and recreated for a change in this field to take effect.
+ description: PodManagementPolicy defines the policy for creating
+ pods under a stateful set. Override the default value of
+ Parallel. This cannot be updated on an existing StatefulSet,
+ the StatefulSet must be deleted and recreated for a change
+ in this field to take effect.
enum:
- OrderedReady
- Parallel
@@ -4678,87 +7656,151 @@
type: object
type: object
dataStorage:
- description: Customize how the cloud data is stored. If neither "persistent" or "ephemeral" is provided, then ephemeral storage will be used by default.
+ description: Customize how the cloud data is stored. If neither "persistent"
+ or "ephemeral" is provided, then ephemeral storage will be used
+ by default.
properties:
ephemeral:
- description: "EphemeralStorage is the specification for how the ephemeral Solr data storage should be configured. \n This option cannot be used with the \"persistent\" option. Ephemeral storage is used by default if neither \"persistent\" or \"ephemeral\" is provided."
+ description: "EphemeralStorage is the specification for how the
+ ephemeral Solr data storage should be configured. \n This option
+ cannot be used with the \"persistent\" option. Ephemeral storage
+ is used by default if neither \"persistent\" or \"ephemeral\"
+ is provided."
properties:
emptyDir:
- description: EmptyDirVolumeSource is an optional config for the emptydir volume that will store Solr data.
+ description: EmptyDirVolumeSource is an optional config for
+ the emptydir volume that will store Solr data.
properties:
medium:
- description: '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'
+ description: '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'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
+ description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
hostPath:
- description: "HostPathVolumeSource is an optional config to specify a path on the host machine to store Solr data. \n If hostPath is omitted, then the default EmptyDir is used, otherwise hostPath takes precedence over EmptyDir."
+ description: "HostPathVolumeSource is an optional config to
+ specify a path on the host machine to store Solr data. \n
+ If hostPath is omitted, then the default EmptyDir is used,
+ otherwise hostPath takes precedence over EmptyDir."
properties:
path:
- description: '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'
+ description: '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'
type: string
type:
- description: 'Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
+ description: 'Type for HostPath Volume Defaults to ""
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
type: object
persistent:
- description: "PersistentStorage is the specification for how the persistent Solr data storage should be configured. \n This option cannot be used with the \"ephemeral\" option."
+ description: "PersistentStorage is the specification for how the
+ persistent Solr data storage should be configured. \n This option
+ cannot be used with the \"ephemeral\" option."
properties:
pvcTemplate:
- description: PersistentVolumeClaimTemplate is the PVC object for the solr node to store its data. Within metadata, the Name, Labels and Annotations are able to be specified, but defaults will be provided if necessary. The entire Spec is customizable, however there will be defaults provided if necessary. This field is optional. If no PVC spec is provided, then a default will be provided.
+ description: PersistentVolumeClaimTemplate is the PVC object
+ for the solr node to store its data. Within metadata, the
+ Name, Labels and Annotations are able to be specified, but
+ defaults will be provided if necessary. The entire Spec
+ is customizable, however there will be defaults provided
+ if necessary. This field is optional. If no PVC spec is
+ provided, then a default will be provided.
properties:
metadata:
- description: 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.
+ description: 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.
properties:
annotations:
additionalProperties:
type: string
- description: 'Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
+ description: 'Annotations is an unstructured key value
+ map stored with a resource that may be set by external
+ tools to store and retrieve arbitrary metadata.
+ They are not queryable and should be preserved when
+ modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
type: object
labels:
additionalProperties:
type: string
- description: 'Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels'
+ description: 'Map of string keys and values that can
+ be used to organize and categorize (scope and select)
+ objects. May match selectors of replication controllers
+ and services. More info: http://kubernetes.io/docs/user-guide/labels'
type: object
name:
- description: 'Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
+ description: 'Name must be unique within a namespace.
+ Is required when creating resources, although some
+ resources may allow a client to request the generation
+ of an appropriate name automatically. Name is primarily
+ intended for creation idempotence and configuration
+ definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
type: string
type: object
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.
+ 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.
properties:
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'
+ description: 'AccessModes contains the desired access
+ modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. 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.'
+ description: 'This field can be used to specify either:
+ * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
+ * An existing PVC (PersistentVolumeClaim) * An existing
+ custom resource that implements data population
+ (Alpha) In order to use custom resource types that
+ implement data population, the AnyVolumeDataSource
+ feature gate must be enabled. 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.'
properties:
apiGroup:
- description: 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.
+ description: 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.
type: string
kind:
- description: Kind is the type of resource being referenced
+ description: Kind is the type of resource being
+ referenced
type: string
name:
- description: Name is the name of resource being referenced
+ description: Name is the name of resource being
+ referenced
type: string
required:
- kind
- name
type: object
resources:
- description: 'Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'Resources represents the minimum resources
+ the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
@@ -4767,7 +7809,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -4776,25 +7819,43 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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. More info:
+ https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
selector:
- description: A label query over volumes to consider for binding.
+ description: A label query over volumes to consider
+ for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label
+ selector requirements. The requirements are
+ ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement is
+ a selector that contains values, a key, and
+ an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label key that the
+ selector applies to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's
+ relationship to a set of values. Valid
+ operators are In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -4806,22 +7867,38 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
storageClassName:
- description: 'Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'Name of the StorageClass required by
+ the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
+ description: volumeMode defines what type of volume
+ is required by the claim. Value of Filesystem is
+ implied when not included in claim spec.
type: string
volumeName:
- description: VolumeName is the binding reference to the PersistentVolume backing this claim.
+ description: VolumeName is the binding reference to
+ the PersistentVolume backing this claim.
type: string
type: object
type: object
reclaimPolicy:
- description: 'VolumeReclaimPolicy determines how the Solr Cloud''s PVCs will be treated after the cloud is deleted. - Retain: This is the default Kubernetes policy, where PVCs created for StatefulSets are not deleted when the StatefulSet is deleted. - Delete: The PVCs will be deleted by the Solr Operator after the SolrCloud object is deleted. The default value is Retain, so no data will be deleted unless explicitly configured.'
+ description: 'VolumeReclaimPolicy determines how the Solr
+ Cloud''s PVCs will be treated after the cloud is deleted. -
+ Retain: This is the default Kubernetes policy, where PVCs
+ created for StatefulSets are not deleted when the StatefulSet
+ is deleted. - Delete: The PVCs will be deleted by the
+ Solr Operator after the SolrCloud object is deleted. The
+ default value is Retain, so no data will be deleted unless
+ explicitly configured.'
enum:
- Retain
- Delete
@@ -4833,182 +7910,302 @@
format: int32
type: integer
solrAddressability:
- description: Customize how Solr is addressed both internally and externally in Kubernetes.
+ description: Customize how Solr is addressed both internally and externally
+ in Kubernetes.
properties:
commonServicePort:
- description: CommonServicePort defines the port to have the common Solr service listen on. Defaults to 80 (when not using TLS) or 443 (when using TLS)
+ description: CommonServicePort defines the port to have the common
+ Solr service listen on. Defaults to 80 (when not using TLS)
+ or 443 (when using TLS)
type: integer
external:
- description: External defines the way in which this SolrCloud nodes should be made addressable externally, from outside the Kubernetes cluster. If none is provided, the Solr Cloud will not be made addressable externally.
+ description: External defines the way in which this SolrCloud
+ nodes should be made addressable externally, from outside the
+ Kubernetes cluster. If none is provided, the Solr Cloud will
+ not be made addressable externally.
properties:
additionalDomainNames:
- description: Provide additional domainNames that the Ingress or ExternalDNS should listen on. This option is ignored with the LoadBalancer method.
+ description: Provide additional domainNames that the Ingress
+ or ExternalDNS should listen on. This option is ignored
+ with the LoadBalancer method.
items:
type: string
type: array
additionalDomains:
- description: "Provide additional domainNames that the Ingress or ExternalDNS should listen on. This option is ignored with the LoadBalancer method. \n DEPRECATED: Please use additionalDomainNames instead. This will be removed in a future version."
+ description: "Provide additional domainNames that the Ingress
+ or ExternalDNS should listen on. This option is ignored
+ with the LoadBalancer method. \n DEPRECATED: Please use
+ additionalDomainNames instead. This will be removed in a
+ future version."
items:
type: string
type: array
domainName:
- description: "Override the domainName provided as startup parameters to the operator, used by ingresses and externalDNS. The common and/or node services will be addressable by unique names under the given domain. e.g. given.domain.name.com -> default-example-solrcloud.given.domain.name.com \n For the LoadBalancer method, this field is optional and will only be used when useExternalAddress=true. If used with the LoadBalancer method, you will need DNS routing to the LoadBalancer IP address through the url template given above."
+ description: "Override the domainName provided as startup
+ parameters to the operator, used by ingresses and externalDNS.
+ The common and/or node services will be addressable by unique
+ names under the given domain. e.g. given.domain.name.com
+ -> default-example-solrcloud.given.domain.name.com \n For
+ the LoadBalancer method, this field is optional and will
+ only be used when useExternalAddress=true. If used with
+ the LoadBalancer method, you will need DNS routing to the
+ LoadBalancer IP address through the url template given above."
type: string
hideCommon:
- description: Do not expose the common Solr service externally. This affects a single service. Defaults to false.
+ description: Do not expose the common Solr service externally.
+ This affects a single service. Defaults to false.
type: boolean
hideNodes:
- description: Do not expose each of the Solr Node services externally. The number of services this affects could range from 1 (a headless service for ExternalDNS) to the number of Solr pods your cloud contains (individual node services for Ingress/LoadBalancer). Defaults to false.
+ description: Do not expose each of the Solr Node services
+ externally. The number of services this affects could range
+ from 1 (a headless service for ExternalDNS) to the number
+ of Solr pods your cloud contains (individual node services
+ for Ingress/LoadBalancer). Defaults to false.
type: boolean
ingressTLSTermination:
- description: "IngressTLSTermination tells the SolrCloud Ingress to terminate TLS on incoming connections. \n This is option is only available when Method=Ingress, because ExternalDNS and LoadBalancer Services do not support TLS termination. This option is also unavailable when the SolrCloud has TLS enabled via `spec.solrTLS`, in this case the Ingress cannot terminate TLS before reaching Solr. \n When using this option, the UseExternalAddress option will be disabled, since Solr cannot be running in HTTP mode and making internal requests in HTTPS."
+ description: "IngressTLSTermination tells the SolrCloud Ingress
+ to terminate TLS on incoming connections. \n This is option
+ is only available when Method=Ingress, because ExternalDNS
+ and LoadBalancer Services do not support TLS termination.
+ This option is also unavailable when the SolrCloud has TLS
+ enabled via `spec.solrTLS`, in this case the Ingress cannot
+ terminate TLS before reaching Solr. \n When using this option,
+ the UseExternalAddress option will be disabled, since Solr
+ cannot be running in HTTP mode and making internal requests
+ in HTTPS."
maxProperties: 1
properties:
tlsSecret:
- description: TLSSecret defines a TLS Secret to use for TLS termination of all exposed addresses for this SolrCloud in the Ingress.
+ description: TLSSecret defines a TLS Secret to use for
+ TLS termination of all exposed addresses for this SolrCloud
+ in the Ingress.
type: string
useDefaultTLSSecret:
- description: "UseDefaultTLSSecret determines whether the ingress should use the default TLS secret provided by the Ingress implementation. \n For example, using nginx: https://kubernetes.github.io/ingress-nginx/user-guide/tls/#default-ssl-certificate"
+ description: "UseDefaultTLSSecret determines whether the
+ ingress should use the default TLS secret provided by
+ the Ingress implementation. \n For example, using nginx:
+ https://kubernetes.github.io/ingress-nginx/user-guide/tls/#default-ssl-certificate"
type: boolean
type: object
ingressTLSTerminationSecret:
- description: "IngressTLSTerminationSecret defines a TLS Secret to use for TLS termination of all exposed addresses in the ingress. \n This is option is only available when Method=Ingress, because ExternalDNS and LoadBalancer Services do not support TLS termination. This option is also unavailable when the SolrCloud has TLS enabled via `spec.solrTLS`, in this case the Ingress cannot terminate TLS before reaching Solr. \n When using this option, the UseExternalAddress option will be disabled, since Solr cannot be running in HTTP mode and making internal requests in HTTPS. \n DEPRECATED: Use ingressTLSTermination.tlsSecret instead"
+ description: "IngressTLSTerminationSecret defines a TLS Secret
+ to use for TLS termination of all exposed addresses in the
+ ingress. \n This is option is only available when Method=Ingress,
+ because ExternalDNS and LoadBalancer Services do not support
+ TLS termination. This option is also unavailable when the
+ SolrCloud has TLS enabled via `spec.solrTLS`, in this case
+ the Ingress cannot terminate TLS before reaching Solr. \n
+ When using this option, the UseExternalAddress option will
+ be disabled, since Solr cannot be running in HTTP mode and
+ making internal requests in HTTPS. \n DEPRECATED: Use ingressTLSTermination.tlsSecret
+ instead"
type: string
method:
- description: The way in which this SolrCloud's service(s) should be made addressable externally.
+ description: The way in which this SolrCloud's service(s)
+ should be made addressable externally.
enum:
- Ingress
- ExternalDNS
type: string
nodePortOverride:
- description: "NodePortOverride defines the port to have all Solr node service(s) listen on and advertise itself as if advertising through an Ingress or LoadBalancer. This overrides the default usage of the podPort. \n This is option is only used when HideNodes=false, otherwise the the port each Solr Node will advertise itself with the podPort. This option is also unavailable with the ExternalDNS method. \n If using method=Ingress, your ingress controller is required to listen on this port. If your ingress controller is not listening on the podPort, then this option is required for solr to be addressable via an Ingress. \n Defaults to 80 (without TLS) or 443 (with TLS) if HideNodes=false and method=Ingress, otherwise this is optional."
+ description: "NodePortOverride defines the port to have all
+ Solr node service(s) listen on and advertise itself as if
+ advertising through an Ingress or LoadBalancer. This overrides
+ the default usage of the podPort. \n This is option is only
+ used when HideNodes=false, otherwise the the port each Solr
+ Node will advertise itself with the podPort. This option
+ is also unavailable with the ExternalDNS method. \n If using
+ method=Ingress, your ingress controller is required to listen
+ on this port. If your ingress controller is not listening
+ on the podPort, then this option is required for solr to
+ be addressable via an Ingress. \n Defaults to 80 (without
+ TLS) or 443 (with TLS) if HideNodes=false and method=Ingress,
+ otherwise this is optional."
type: integer
useExternalAddress:
- description: "Use the external address to advertise the SolrNode, defaults to false. \n If false, the external address will be available, however Solr (and clients using the CloudSolrClient in SolrJ) will only be aware of the internal URLs. If true, Solr will startup with the hostname of the external address. \n NOTE: This option cannot be true when hideNodes is set to true. So it will be auto-set to false if that is the case."
+ description: "Use the external address to advertise the SolrNode,
+ defaults to false. \n If false, the external address will
+ be available, however Solr (and clients using the CloudSolrClient
+ in SolrJ) will only be aware of the internal URLs. If true,
+ Solr will startup with the hostname of the external address.
+ \n NOTE: This option cannot be true when hideNodes is set
+ to true. So it will be auto-set to false if that is the
+ case."
type: boolean
required:
- domainName
- method
type: object
kubeDomain:
- description: KubeDomain allows for the specification of an override of the default "cluster.local" Kubernetes cluster domain. Only use this option if the Kubernetes cluster has been setup with a custom domain.
+ description: KubeDomain allows for the specification of an override
+ of the default "cluster.local" Kubernetes cluster domain. Only
+ use this option if the Kubernetes cluster has been setup with
+ a custom domain.
type: string
podPort:
- description: PodPort defines the port to have the Solr Pod listen on. Defaults to 8983
+ description: PodPort defines the port to have the Solr Pod listen
+ on. Defaults to 8983
type: integer
type: object
solrClientTLS:
- description: Options to configure client TLS certificate for Solr pods
+ description: Options to configure client TLS certificate for Solr
+ pods
properties:
checkPeerName:
- description: TLS certificates contain host/ip "peer name" information that is validated by default.
+ description: TLS certificates contain host/ip "peer name" information
+ that is validated by default.
type: boolean
clientAuth:
default: None
- description: Determines the client authentication method, either None, Want, or Need; this affects K8s ability to call liveness / readiness probes so use cautiously. Only applies for server certificates, has no effect on client certificates
+ description: Determines the client authentication method, either
+ None, Want, or Need; this affects K8s ability to call liveness
+ / readiness probes so use cautiously. Only applies for server
+ certificates, has no effect on client certificates
enum:
- None
- Want
- Need
type: string
keyStorePasswordSecret:
- description: Secret containing the key store password; this field is required unless mountedTLSDir is used, as most JVMs do not support pkcs12 keystores without a password
+ description: Secret containing the key store password; this field
+ is required unless mountedTLSDir is used, as most JVMs do not
+ support pkcs12 keystores without a password
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
mountedTLSDir:
- description: Used to specify a path where the keystore, truststore, and password files for the TLS certificate are mounted by an external agent or CSI driver. This option is typically used with `spec.updateStrategy.restartSchedule` to restart Solr pods before the mounted TLS cert expires.
+ description: Used to specify a path where the keystore, truststore,
+ and password files for the TLS certificate are mounted by an
+ external agent or CSI driver. This option is typically used
+ with `spec.updateStrategy.restartSchedule` to restart Solr pods
+ before the mounted TLS cert expires.
properties:
keystoreFile:
- description: Override the name of the keystore file; no default, if you don't supply this setting, then the corresponding env vars and Java system properties will not be configured for the pod template
+ description: Override the name of the keystore file; no default,
+ if you don't supply this setting, then the corresponding
+ env vars and Java system properties will not be configured
+ for the pod template
type: string
keystorePasswordFile:
- description: Override the name of the keystore password file; defaults to keystore-password
+ description: Override the name of the keystore password file;
+ defaults to keystore-password
type: string
path:
- description: The path on the main Solr container where the TLS files are mounted by some external agent or CSI Driver
+ description: The path on the main Solr container where the
+ TLS files are mounted by some external agent or CSI Driver
type: string
truststoreFile:
- description: Override the name of the truststore file; no default, if you don't supply this setting, then the corresponding env vars and Java system properties will not be configured for the pod template
+ description: Override the name of the truststore file; no
+ default, if you don't supply this setting, then the corresponding
+ env vars and Java system properties will not be configured
+ for the pod template
type: string
truststorePasswordFile:
- description: Override the name of the truststore password file; defaults to the same value as the KeystorePasswordFile
+ description: Override the name of the truststore password
+ file; defaults to the same value as the KeystorePasswordFile
type: string
required:
- path
type: object
pkcs12Secret:
- description: TLS Secret containing a pkcs12 keystore; required for Solr pods unless mountedTLSDir is used
+ description: TLS Secret containing a pkcs12 keystore; required
+ for Solr pods unless mountedTLSDir is used
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
restartOnTLSSecretUpdate:
- description: Opt-in flag to restart Solr pods after TLS secret updates, such as if the cert is renewed; default is false. This option only applies when using the `spec.solrTLS.pkcs12Secret` option; when using the `spec.solrTLS.mountedTLSDir` option, you need to ensure pods get restarted before the certs expire, see `spec.updateStrategy.restartSchedule` for scheduling restarts.
+ description: Opt-in flag to restart Solr pods after TLS secret
+ updates, such as if the cert is renewed; default is false. This
+ option only applies when using the `spec.solrTLS.pkcs12Secret`
+ option; when using the `spec.solrTLS.mountedTLSDir` option,
+ you need to ensure pods get restarted before the certs expire,
+ see `spec.updateStrategy.restartSchedule` for scheduling restarts.
type: boolean
trustStorePasswordSecret:
- description: Secret containing the trust store password; if not provided the keyStorePassword will be used
+ description: Secret containing the trust store password; if not
+ provided the keyStorePassword will be used
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
trustStoreSecret:
- description: TLS Secret containing a pkcs12 truststore; if not provided, then the keystore and password are used for the truststore The specified key is used as the truststore file name when mounted into Solr pods
+ description: TLS Secret containing a pkcs12 truststore; if not
+ provided, then the keystore and password are used for the truststore
+ The specified key is used as the truststore file name when mounted
+ into Solr pods
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
verifyClientHostname:
- description: Verify client's hostname during SSL handshake Only applies for server configuration
+ description: Verify client's hostname during SSL handshake Only
+ applies for server configuration
type: boolean
type: object
solrGCTune:
- description: Set GC Tuning configuration through GC_TUNE environment variable
+ description: Set GC Tuning configuration through GC_TUNE environment
+ variable
type: string
solrImage:
- description: ContainerImage defines the fields needed for a Docker repository image. The format here matches the predominant format used in Helm charts.
+ description: ContainerImage defines the fields needed for a Docker
+ repository image. The format here matches the predominant format
+ used in Helm charts.
properties:
imagePullSecret:
type: string
pullPolicy:
- description: PullPolicy describes a policy for if/when to pull a container image
+ description: PullPolicy describes a policy for if/when to pull
+ a container image
type: string
repository:
type: string
@@ -5021,147 +8218,229 @@
description: Set the Solr Log level, defaults to INFO
type: string
solrModules:
- description: 'List of Solr Modules to be loaded when starting Solr Note: You do not need to specify a module if it is required by another property (e.g. backupRepositories[].gcs)'
+ description: 'List of Solr Modules to be loaded when starting Solr
+ Note: You do not need to specify a module if it is required by another
+ property (e.g. backupRepositories[].gcs)'
items:
type: string
type: array
solrOpts:
- description: You can add common system properties to the SOLR_OPTS environment variable SolrOpts is the string interface for these optional settings
+ description: You can add common system properties to the SOLR_OPTS
+ environment variable SolrOpts is the string interface for these
+ optional settings
type: string
solrSecurity:
description: Options to enable Solr security
properties:
authenticationType:
- description: Indicates the authentication plugin type that is being used by Solr; for now only "Basic" is supported by the Solr operator but support for other authentication plugins may be added in the future.
+ description: Indicates the authentication plugin type that is
+ being used by Solr; for now only "Basic" is supported by the
+ Solr operator but support for other authentication plugins may
+ be added in the future.
enum:
- Basic
type: string
basicAuthSecret:
- description: "Secret (kubernetes.io/basic-auth) containing credentials the operator should use for API requests to secure Solr pods. If you provide this secret, then the operator assumes you've also configured your own security.json file and uploaded it to Solr. If you change the password for this user using the Solr security API, then you *must* update the secret with the new password or the operator will be locked out of Solr and API requests will fail, ultimately causing a CrashBackoffLoop for all pods if probe endpoints are secured (see 'probesRequireAuth' setting). \n If you don't supply this secret, then the operator creates a kubernetes.io/basic-auth secret containing the password for the \"k8s-oper\" user. All API requests from the operator are made as the \"k8s-oper\" user, which is configured with read-only access to a minimal set of endpoints. In addition, the operator bootstraps a default security.json file and credentials for two additional users: admin and solr. The 'solr' user has basic read access to Solr resources. Once the security.json is bootstrapped, the operator will not update it! You're expected to use the 'admin' user to access the Security API to make further changes. It's strictly a bootstrapping operation."
+ description: "Secret (kubernetes.io/basic-auth) containing credentials
+ the operator should use for API requests to secure Solr pods.
+ If you provide this secret, then the operator assumes you've
+ also configured your own security.json file and uploaded it
+ to Solr. If you change the password for this user using the
+ Solr security API, then you *must* update the secret with the
+ new password or the operator will be locked out of Solr and
+ API requests will fail, ultimately causing a CrashBackoffLoop
+ for all pods if probe endpoints are secured (see 'probesRequireAuth'
+ setting). \n If you don't supply this secret, then the operator
+ creates a kubernetes.io/basic-auth secret containing the password
+ for the \"k8s-oper\" user. All API requests from the operator
+ are made as the \"k8s-oper\" user, which is configured with
+ read-only access to a minimal set of endpoints. In addition,
+ the operator bootstraps a default security.json file and credentials
+ for two additional users: admin and solr. The 'solr' user has
+ basic read access to Solr resources. Once the security.json
+ is bootstrapped, the operator will not update it! You're expected
+ to use the 'admin' user to access the Security API to make further
+ changes. It's strictly a bootstrapping operation."
type: string
bootstrapSecurityJson:
- description: Configure a user-provided security.json from a secret to allow for advanced security config. If not specified, the operator bootstraps a security.json with basic auth enabled. This is a bootstrapping config only; once Solr is initialized, the security config should be managed by the security API.
+ description: Configure a user-provided security.json from a secret
+ to allow for advanced security config. If not specified, the
+ operator bootstraps a security.json with basic auth enabled.
+ This is a bootstrapping config only; once Solr is initialized,
+ the security config should be managed by the security API.
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
probesRequireAuth:
- description: Flag to indicate if the configured HTTP endpoint(s) used for the probes require authentication; defaults to false. If you set to true, then probes will use a local command on the main container to hit the secured endpoints with credentials sourced from an env var instead of HTTP directly.
+ description: Flag to indicate if the configured HTTP endpoint(s)
+ used for the probes require authentication; defaults to false.
+ If you set to true, then probes will use a local command on
+ the main container to hit the secured endpoints with credentials
+ sourced from an env var instead of HTTP directly.
type: boolean
type: object
solrTLS:
- description: Options to enable the server TLS certificate for Solr pods
+ description: Options to enable the server TLS certificate for Solr
+ pods
properties:
checkPeerName:
- description: TLS certificates contain host/ip "peer name" information that is validated by default.
+ description: TLS certificates contain host/ip "peer name" information
+ that is validated by default.
type: boolean
clientAuth:
default: None
- description: Determines the client authentication method, either None, Want, or Need; this affects K8s ability to call liveness / readiness probes so use cautiously. Only applies for server certificates, has no effect on client certificates
+ description: Determines the client authentication method, either
+ None, Want, or Need; this affects K8s ability to call liveness
+ / readiness probes so use cautiously. Only applies for server
+ certificates, has no effect on client certificates
enum:
- None
- Want
- Need
type: string
keyStorePasswordSecret:
- description: Secret containing the key store password; this field is required unless mountedTLSDir is used, as most JVMs do not support pkcs12 keystores without a password
+ description: Secret containing the key store password; this field
+ is required unless mountedTLSDir is used, as most JVMs do not
+ support pkcs12 keystores without a password
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
mountedTLSDir:
- description: Used to specify a path where the keystore, truststore, and password files for the TLS certificate are mounted by an external agent or CSI driver. This option is typically used with `spec.updateStrategy.restartSchedule` to restart Solr pods before the mounted TLS cert expires.
+ description: Used to specify a path where the keystore, truststore,
+ and password files for the TLS certificate are mounted by an
+ external agent or CSI driver. This option is typically used
+ with `spec.updateStrategy.restartSchedule` to restart Solr pods
+ before the mounted TLS cert expires.
properties:
keystoreFile:
- description: Override the name of the keystore file; no default, if you don't supply this setting, then the corresponding env vars and Java system properties will not be configured for the pod template
+ description: Override the name of the keystore file; no default,
+ if you don't supply this setting, then the corresponding
+ env vars and Java system properties will not be configured
+ for the pod template
type: string
keystorePasswordFile:
- description: Override the name of the keystore password file; defaults to keystore-password
+ description: Override the name of the keystore password file;
+ defaults to keystore-password
type: string
path:
- description: The path on the main Solr container where the TLS files are mounted by some external agent or CSI Driver
+ description: The path on the main Solr container where the
+ TLS files are mounted by some external agent or CSI Driver
type: string
truststoreFile:
- description: Override the name of the truststore file; no default, if you don't supply this setting, then the corresponding env vars and Java system properties will not be configured for the pod template
+ description: Override the name of the truststore file; no
+ default, if you don't supply this setting, then the corresponding
+ env vars and Java system properties will not be configured
+ for the pod template
type: string
truststorePasswordFile:
- description: Override the name of the truststore password file; defaults to the same value as the KeystorePasswordFile
+ description: Override the name of the truststore password
+ file; defaults to the same value as the KeystorePasswordFile
type: string
required:
- path
type: object
pkcs12Secret:
- description: TLS Secret containing a pkcs12 keystore; required for Solr pods unless mountedTLSDir is used
+ description: TLS Secret containing a pkcs12 keystore; required
+ for Solr pods unless mountedTLSDir is used
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
restartOnTLSSecretUpdate:
- description: Opt-in flag to restart Solr pods after TLS secret updates, such as if the cert is renewed; default is false. This option only applies when using the `spec.solrTLS.pkcs12Secret` option; when using the `spec.solrTLS.mountedTLSDir` option, you need to ensure pods get restarted before the certs expire, see `spec.updateStrategy.restartSchedule` for scheduling restarts.
+ description: Opt-in flag to restart Solr pods after TLS secret
+ updates, such as if the cert is renewed; default is false. This
+ option only applies when using the `spec.solrTLS.pkcs12Secret`
+ option; when using the `spec.solrTLS.mountedTLSDir` option,
+ you need to ensure pods get restarted before the certs expire,
+ see `spec.updateStrategy.restartSchedule` for scheduling restarts.
type: boolean
trustStorePasswordSecret:
- description: Secret containing the trust store password; if not provided the keyStorePassword will be used
+ description: Secret containing the trust store password; if not
+ provided the keyStorePassword will be used
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
trustStoreSecret:
- description: TLS Secret containing a pkcs12 truststore; if not provided, then the keystore and password are used for the truststore The specified key is used as the truststore file name when mounted into Solr pods
+ description: TLS Secret containing a pkcs12 truststore; if not
+ provided, then the keystore and password are used for the truststore
+ The specified key is used as the truststore file name when mounted
+ into Solr pods
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
verifyClientHostname:
- description: Verify client's hostname during SSL handshake Only applies for server configuration
+ description: Verify client's hostname during SSL handshake Only
+ applies for server configuration
type: boolean
type: object
solrZkOpts:
- description: This will add java system properties for connecting to Zookeeper. SolrZkOpts is the string interface for these optional settings
+ description: This will add java system properties for connecting to
+ Zookeeper. SolrZkOpts is the string interface for these optional
+ settings
type: string
updateStrategy:
description: Define how Solr rolling updates are executed.
@@ -5173,43 +8452,72 @@
anyOf:
- type: integer
- type: string
- description: "The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of the desired number of pods (ex: 10%). Absolute number is calculated from percentage by rounding down. If the provided number is 0 or negative, then all pods will be allowed to be updated in unison. \n Defaults to 25%."
+ description: "The maximum number of pods that can be unavailable
+ during the update. Value can be an absolute number (ex:
+ 5) or a percentage of the desired number of pods (ex: 10%).
+ Absolute number is calculated from percentage by rounding
+ down. If the provided number is 0 or negative, then all
+ pods will be allowed to be updated in unison. \n Defaults
+ to 25%."
x-kubernetes-int-or-string: true
maxShardReplicasUnavailable:
anyOf:
- type: integer
- type: string
- description: "The maximum number of replicas for each shard that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of replicas in a shard (ex: 25%). Absolute number is calculated from percentage by rounding down. If the provided number is 0 or negative, then all replicas will be allowed to be updated in unison. \n Defaults to 1."
+ description: "The maximum number of replicas for each shard
+ that can be unavailable during the update. Value can be
+ an absolute number (ex: 5) or a percentage of replicas in
+ a shard (ex: 25%). Absolute number is calculated from percentage
+ by rounding down. If the provided number is 0 or negative,
+ then all replicas will be allowed to be updated in unison.
+ \n Defaults to 1."
x-kubernetes-int-or-string: true
type: object
method:
- description: Method defines the way in which SolrClouds should be updated when the podSpec changes.
+ description: Method defines the way in which SolrClouds should
+ be updated when the podSpec changes.
enum:
- Managed
- StatefulSet
- Manual
type: string
restartSchedule:
- description: "Perform a scheduled restart on the given schedule, in CRON format. \n Multiple CRON syntaxes are supported - Standard CRON (e.g. \"CRON_TZ=Asia/Seoul 0 6 * * ?\") - Predefined Schedules (e.g. \"@yearly\", \"@weekly\", etc.) - Intervals (e.g. \"@every 10h30m\") \n For more information please check this reference: https://pkg.go.dev/github.com/robfig/cron/v3?utm_source=godoc#hdr-CRON_Expression_Format"
+ description: "Perform a scheduled restart on the given schedule,
+ in CRON format. \n Multiple CRON syntaxes are supported -
+ Standard CRON (e.g. \"CRON_TZ=Asia/Seoul 0 6 * * ?\") - Predefined
+ Schedules (e.g. \"@yearly\", \"@weekly\", etc.) - Intervals
+ (e.g. \"@every 10h30m\") \n For more information please check
+ this reference: https://pkg.go.dev/github.com/robfig/cron/v3?utm_source=godoc#hdr-CRON_Expression_Format"
type: string
type: object
zookeeperRef:
- description: The information for the Zookeeper this SolrCloud should connect to Can be a zookeeper that is running, or one that is created by the solr operator
+ description: The information for the Zookeeper this SolrCloud should
+ connect to Can be a zookeeper that is running, or one that is created
+ by the solr operator
properties:
connectionInfo:
- description: A zookeeper ensemble that is run independently of the solr operator If an externalConnectionString is provided, but no internalConnectionString is, the external will be used as the internal
+ description: A zookeeper ensemble that is run independently of
+ the solr operator If an externalConnectionString is provided,
+ but no internalConnectionString is, the external will be used
+ as the internal
properties:
acl:
- description: ZooKeeper ACL to use when connecting with ZK. This ACL should have ALL permission in the given chRoot.
+ description: ZooKeeper ACL to use when connecting with ZK.
+ This ACL should have ALL permission in the given chRoot.
properties:
passwordKey:
- description: The name of the key in the given secret that contains the ACL password
+ description: The name of the key in the given secret that
+ contains the ACL password
type: string
secret:
- description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
+ description: The name of the Kubernetes Secret that stores
+ the username and password for the ACL. This secret must
+ be in the same namespace as the solrCloud or prometheusExporter
+ is running in.
type: string
usernameKey:
- description: The name of the key in the given secret that contains the ACL username
+ description: The name of the key in the given secret that
+ contains the ACL username
type: string
required:
- passwordKey
@@ -5220,22 +8528,33 @@
description: The ChRoot to connect solr at
type: string
externalConnectionString:
- description: The connection string to connect to the ensemble from outside of the Kubernetes cluster If external and no internal connection string is provided, the external cnx string will be used as the internal cnx string
+ description: The connection string to connect to the ensemble
+ from outside of the Kubernetes cluster If external and no
+ internal connection string is provided, the external cnx
+ string will be used as the internal cnx string
type: string
internalConnectionString:
- description: The connection string to connect to the ensemble from within the Kubernetes cluster
+ description: The connection string to connect to the ensemble
+ from within the Kubernetes cluster
type: string
readOnlyAcl:
- description: ZooKeeper ACL to use when connecting with ZK for reading operations. This ACL should have READ permission in the given chRoot.
+ description: ZooKeeper ACL to use when connecting with ZK
+ for reading operations. This ACL should have READ permission
+ in the given chRoot.
properties:
passwordKey:
- description: The name of the key in the given secret that contains the ACL password
+ description: The name of the key in the given secret that
+ contains the ACL password
type: string
secret:
- description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
+ description: The name of the Kubernetes Secret that stores
+ the username and password for the ACL. This secret must
+ be in the same namespace as the solrCloud or prometheusExporter
+ is running in.
type: string
usernameKey:
- description: The name of the key in the given secret that contains the ACL username
+ description: The name of the key in the given secret that
+ contains the ACL username
type: string
required:
- passwordKey
@@ -5244,19 +8563,29 @@
type: object
type: object
provided:
- description: 'Create a new Zookeeper Ensemble with the following spec Note: This option will not allow the SolrCloud to run across kube-clusters. Note: Requires - The zookeeperOperator flag to be provided to the Solr Operator - A zookeeper operator to be running'
+ description: 'Create a new Zookeeper Ensemble with the following
+ spec Note: This option will not allow the SolrCloud to run across
+ kube-clusters. Note: Requires - The zookeeperOperator flag
+ to be provided to the Solr Operator - A zookeeper operator
+ to be running'
properties:
acl:
- description: ZooKeeper ACL to use when connecting with ZK. This ACL should have ALL permission in the given chRoot.
+ description: ZooKeeper ACL to use when connecting with ZK.
+ This ACL should have ALL permission in the given chRoot.
properties:
passwordKey:
- description: The name of the key in the given secret that contains the ACL password
+ description: The name of the key in the given secret that
+ contains the ACL password
type: string
secret:
- description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
+ description: The name of the Kubernetes Secret that stores
+ the username and password for the ACL. This secret must
+ be in the same namespace as the solrCloud or prometheusExporter
+ is running in.
type: string
usernameKey:
- description: The name of the key in the given secret that contains the ACL username
+ description: The name of the key in the given secret that
+ contains the ACL username
type: string
required:
- passwordKey
@@ -5272,69 +8601,123 @@
additionalConfig:
additionalProperties:
type: string
- description: key-value map of additional zookeeper configuration parameters
+ description: key-value map of additional zookeeper configuration
+ parameters
type: object
x-kubernetes-preserve-unknown-fields: true
autoPurgePurgeInterval:
- description: "The time interval in hours for which the purge task has to be triggered \n Disabled by default"
+ description: "The time interval in hours for which the
+ purge task has to be triggered \n Disabled by default"
type: integer
autoPurgeSnapRetainCount:
- description: "Retain the snapshots according to retain count \n The default value is 3"
+ description: "Retain the snapshots according to retain
+ count \n The default value is 3"
type: integer
commitLogCount:
- description: "Zookeeper maintains an in-memory list of last committed requests for fast synchronization with followers \n The default value is 500"
+ description: "Zookeeper maintains an in-memory list of
+ last committed requests for fast synchronization with
+ followers \n The default value is 500"
type: integer
globalOutstandingLimit:
- description: "Clients can submit requests faster than ZooKeeper can process them, especially if there are a lot of clients. Zookeeper will throttle Clients so that requests won't exceed global outstanding limit. \n The default value is 1000"
+ description: "Clients can submit requests faster than
+ ZooKeeper can process them, especially if there are
+ a lot of clients. Zookeeper will throttle Clients so
+ that requests won't exceed global outstanding limit.
+ \n The default value is 1000"
type: integer
initLimit:
- description: "InitLimit is the amount of time, in ticks, to allow followers to connect and sync to a leader. \n Default value is 10."
+ description: "InitLimit is the amount of time, in ticks,
+ to allow followers to connect and sync to a leader.
+ \n Default value is 10."
type: integer
maxClientCnxns:
- description: "Limits the number of concurrent connections that a single client, identified by IP address, may make to a single member of the ZooKeeper ensemble. \n The default value is 60"
+ description: "Limits the number of concurrent connections
+ that a single client, identified by IP address, may
+ make to a single member of the ZooKeeper ensemble. \n
+ The default value is 60"
type: integer
maxCnxns:
- description: "Limits the total number of concurrent connections that can be made to a zookeeper server \n The defult value is 0, indicating no limit"
+ description: "Limits the total number of concurrent connections
+ that can be made to a zookeeper server \n The defult
+ value is 0, indicating no limit"
type: integer
maxSessionTimeout:
- description: "The maximum session timeout in milliseconds that the server will allow the client to negotiate. \n The default value is 40000"
+ description: "The maximum session timeout in milliseconds
+ that the server will allow the client to negotiate.
+ \n The default value is 40000"
type: integer
minSessionTimeout:
- description: "The minimum session timeout in milliseconds that the server will allow the client to negotiate \n The default value is 4000"
+ description: "The minimum session timeout in milliseconds
+ that the server will allow the client to negotiate \n
+ The default value is 4000"
type: integer
preAllocSize:
- description: "To avoid seeks ZooKeeper allocates space in the transaction log file in blocks of preAllocSize kilobytes \n The default value is 64M"
+ description: "To avoid seeks ZooKeeper allocates space
+ in the transaction log file in blocks of preAllocSize
+ kilobytes \n The default value is 64M"
type: integer
quorumListenOnAllIPs:
- description: "QuorumListenOnAllIPs when set to true the ZooKeeper server will listen for connections from its peers on all available IP addresses, and not only the address configured in the server list of the configuration file. It affects the connections handling the ZAB protocol and the Fast Leader Election protocol. \n The default value is false."
+ description: "QuorumListenOnAllIPs when set to true the
+ ZooKeeper server will listen for connections from its
+ peers on all available IP addresses, and not only the
+ address configured in the server list of the configuration
+ file. It affects the connections handling the ZAB protocol
+ and the Fast Leader Election protocol. \n The default
+ value is false."
type: boolean
snapCount:
- description: "ZooKeeper records its transactions using snapshots and a transaction log The number of transactions recorded in the transaction log before a snapshot can be taken is determined by snapCount \n The default value is 100,000"
+ description: "ZooKeeper records its transactions using
+ snapshots and a transaction log The number of transactions
+ recorded in the transaction log before a snapshot can
+ be taken is determined by snapCount \n The default value
+ is 100,000"
type: integer
snapSizeLimitInKb:
- description: "Snapshot size limit in Kb \n The defult value is 4GB"
+ description: "Snapshot size limit in Kb \n The defult
+ value is 4GB"
type: integer
syncLimit:
- description: "SyncLimit is the amount of time, in ticks, to allow followers to sync with Zookeeper. \n The default value is 2."
+ description: "SyncLimit is the amount of time, in ticks,
+ to allow followers to sync with Zookeeper. \n The default
+ value is 2."
type: integer
tickTime:
- description: "TickTime is the length of a single tick, which is the basic time unit used by Zookeeper, as measured in milliseconds \n The default value is 2000."
+ description: "TickTime is the length of a single tick,
+ which is the basic time unit used by Zookeeper, as measured
+ in milliseconds \n The default value is 2000."
type: integer
type: object
ephemeral:
- description: Ephemeral is the configuration which helps create ephemeral storage At anypoint only one of Persistence or Ephemeral should be present in the manifest
+ description: Ephemeral is the configuration which helps create
+ ephemeral storage At anypoint only one of Persistence or
+ Ephemeral should be present in the manifest
properties:
emptydirvolumesource:
- description: EmptyDirVolumeSource is optional and this will create the emptydir volume It has two parameters Medium and SizeLimit which are optional as well Medium specifies What type of storage medium should back this directory. SizeLimit specifies Total amount of local storage required for this EmptyDir volume.
+ description: EmptyDirVolumeSource is optional and this
+ will create the emptydir volume It has two parameters
+ Medium and SizeLimit which are optional as well Medium
+ specifies What type of storage medium should back this
+ directory. SizeLimit specifies Total amount of local
+ storage required for this EmptyDir volume.
properties:
medium:
- description: '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'
+ description: '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'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
+ description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
@@ -5345,7 +8728,8 @@
imagePullSecret:
type: string
pullPolicy:
- description: PullPolicy describes a policy for if/when to pull a container image
+ description: PullPolicy describes a policy for if/when
+ to pull a container image
type: string
repository:
type: string
@@ -5353,45 +8737,72 @@
type: string
type: object
persistence:
- description: Persistence is the configuration for zookeeper persistent layer. PersistentVolumeClaimSpec and VolumeReclaimPolicy can be specified in here. At anypoint only one of Persistence or Ephemeral should be present in the manifest
+ description: Persistence is the configuration for zookeeper
+ persistent layer. PersistentVolumeClaimSpec and VolumeReclaimPolicy
+ can be specified in here. At anypoint only one of Persistence
+ or Ephemeral should be present in the manifest
properties:
annotations:
additionalProperties:
type: string
- description: Annotations specifies the annotations to attach to pvc the operator creates.
+ description: Annotations specifies the annotations to
+ attach to pvc the operator creates.
type: object
reclaimPolicy:
- description: VolumeReclaimPolicy is a zookeeper operator configuration. If it's set to Delete, the corresponding PVCs will be deleted by the operator when zookeeper cluster is deleted. The default value is Retain.
+ description: VolumeReclaimPolicy is a zookeeper operator
+ configuration. If it's set to Delete, the corresponding
+ PVCs will be deleted by the operator when zookeeper
+ cluster is deleted. The default value is Retain.
enum:
- Retain
- Delete
type: string
spec:
- description: PersistentVolumeClaimSpec is the spec to describe PVC for the container This field is optional. If no PVC is specified default persistentvolume will get created.
+ description: PersistentVolumeClaimSpec is the spec to
+ describe PVC for the container This field is optional.
+ If no PVC is specified default persistentvolume will
+ get created.
properties:
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'
+ description: 'AccessModes contains the desired access
+ modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. 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.'
+ description: 'This field can be used to specify either:
+ * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
+ * An existing PVC (PersistentVolumeClaim) * An existing
+ custom resource that implements data population
+ (Alpha) In order to use custom resource types that
+ implement data population, the AnyVolumeDataSource
+ feature gate must be enabled. 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.'
properties:
apiGroup:
- description: 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.
+ description: 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.
type: string
kind:
- description: Kind is the type of resource being referenced
+ description: Kind is the type of resource being
+ referenced
type: string
name:
- description: Name is the name of resource being referenced
+ description: Name is the name of resource being
+ referenced
type: string
required:
- kind
- name
type: object
resources:
- description: 'Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'Resources represents the minimum resources
+ the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
@@ -5400,7 +8811,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -5409,25 +8821,43 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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. More info:
+ https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
selector:
- description: A label query over volumes to consider for binding.
+ description: A label query over volumes to consider
+ for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label
+ selector requirements. The requirements are
+ ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement is
+ a selector that contains values, a key, and
+ an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label key that the
+ selector applies to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's
+ relationship to a set of values. Valid
+ operators are In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5439,31 +8869,47 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
storageClassName:
- description: 'Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'Name of the StorageClass required by
+ the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
+ description: volumeMode defines what type of volume
+ is required by the claim. Value of Filesystem is
+ implied when not included in claim spec.
type: string
volumeName:
- description: VolumeName is the binding reference to the PersistentVolume backing this claim.
+ description: VolumeName is the binding reference to
+ the PersistentVolume backing this claim.
type: string
type: object
type: object
readOnlyAcl:
- description: ZooKeeper ACL to use when connecting with ZK for reading operations. This ACL should have READ permission in the given chRoot.
+ description: ZooKeeper ACL to use when connecting with ZK
+ for reading operations. This ACL should have READ permission
+ in the given chRoot.
properties:
passwordKey:
- description: The name of the key in the given secret that contains the ACL password
+ description: The name of the key in the given secret that
+ contains the ACL password
type: string
secret:
- description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
+ description: The name of the Kubernetes Secret that stores
+ the username and password for the ACL. This secret must
+ be in the same namespace as the solrCloud or prometheusExporter
+ is running in.
type: string
usernameKey:
- description: The name of the key in the given secret that contains the ACL username
+ description: The name of the key in the given secret that
+ contains the ACL username
type: string
required:
- passwordKey
@@ -5471,7 +8917,8 @@
- usernameKey
type: object
replicas:
- description: Number of members to create up for the ZK ensemble Defaults to 3
+ description: Number of members to create up for the ZK ensemble
+ Defaults to 3
format: int32
type: integer
zookeeperPodPolicy:
@@ -5481,29 +8928,66 @@
description: The scheduling constraints on pods.
properties:
nodeAffinity:
- description: Describes node affinity scheduling rules for the pod.
+ description: Describes node affinity scheduling rules
+ for the pod.
properties:
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.
+ 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.
items:
- 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).
+ 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).
properties:
preference:
- description: A node selector term, associated with the corresponding weight.
+ description: A node selector term, associated
+ with the corresponding weight.
properties:
matchExpressions:
- description: A list of node selector requirements by node's labels.
+ description: A list of node selector
+ requirements by node's labels.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that
+ the selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's
+ relationship to a set of values.
+ Valid operators are In, NotIn,
+ Exists, DoesNotExist. Gt, and
+ Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5513,18 +8997,38 @@
type: object
type: array
matchFields:
- description: A list of node selector requirements by node's fields.
+ description: A list of node selector
+ requirements by node's fields.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that
+ the selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's
+ relationship to a set of values.
+ Valid operators are In, NotIn,
+ Exists, DoesNotExist. Gt, and
+ Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5535,7 +9039,9 @@
type: array
type: object
weight:
- description: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
+ description: Weight associated with matching
+ the corresponding nodeSelectorTerm, in
+ the range 1-100.
format: int32
type: integer
required:
@@ -5544,26 +9050,57 @@
type: object
type: array
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.
+ 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.
properties:
nodeSelectorTerms:
- description: Required. A list of node selector terms. The terms are ORed.
+ description: Required. A list of node selector
+ terms. The terms are ORed.
items:
- 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.
+ 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.
properties:
matchExpressions:
- description: A list of node selector requirements by node's labels.
+ description: A list of node selector
+ requirements by node's labels.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that
+ the selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's
+ relationship to a set of values.
+ Valid operators are In, NotIn,
+ Exists, DoesNotExist. Gt, and
+ Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5573,18 +9110,38 @@
type: object
type: array
matchFields:
- description: A list of node selector requirements by node's fields.
+ description: A list of node selector
+ requirements by node's fields.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that
+ the selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's
+ relationship to a set of values.
+ Valid operators are In, NotIn,
+ Exists, DoesNotExist. Gt, and
+ Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5600,32 +9157,72 @@
type: object
type: object
podAffinity:
- description: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
+ description: Describes pod affinity scheduling rules
+ (e.g. co-locate this pod in the same node, zone,
+ etc. as some other pod(s)).
properties:
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 has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
+ 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 has
+ pods which matches the corresponding podAffinityTerm;
+ the node(s) with the highest sum are the most
+ preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched
+ WeightedPodAffinityTerm fields are added per-node
+ to find the most preferred node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated with the corresponding weight.
+ description: Required. A pod affinity term,
+ associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set
+ of resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is
+ a list of label selector requirements.
+ The requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector
+ requirement is a selector that
+ contains values, a key, and
+ an operator that relates the
+ key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to
+ a set of values. Valid operators
+ are In, NotIn, Exists and
+ DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5637,22 +9234,44 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which
+ namespaces the labelSelector applies
+ to (matches against); null or empty
+ list means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located
+ (affinity) or not co-located (anti-affinity)
+ with the pods matching the labelSelector
+ in the specified namespaces, where
+ co-located is defined as running on
+ a node whose value of the label with
+ key topologyKey matches that of any
+ node on which any of the selected
+ pods is running. Empty topologyKey
+ is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
+ description: weight associated with matching
+ the corresponding podAffinityTerm, in
+ the range 1-100.
format: int32
type: integer
required:
@@ -5661,26 +9280,61 @@
type: object
type: array
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 a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
+ 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 a pod label update),
+ the system may or may not try to eventually
+ evict the pod from its node. When there are
+ multiple elements, the lists of nodes corresponding
+ to each podAffinityTerm are intersected, i.e.
+ all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
+ description: Defines a set of pods (namely those
+ matching the labelSelector relative to the
+ given namespace(s)) that this pod should be
+ co-located (affinity) or not co-located (anti-affinity)
+ with, where co-located is defined as running
+ on a node whose value of the label with key
+ <topologyKey> matches that of any node on
+ which a pod of the set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of
+ resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The
+ requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a set
+ of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5692,16 +9346,34 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which
+ namespaces the labelSelector applies to
+ (matches against); null or empty list
+ means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located
+ (affinity) or not co-located (anti-affinity)
+ with the pods matching the labelSelector
+ in the specified namespaces, where co-located
+ is defined as running on a node whose
+ value of the label with key topologyKey
+ matches that of any node on which any
+ of the selected pods is running. Empty
+ topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -5709,32 +9381,72 @@
type: array
type: object
podAntiAffinity:
- description: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
+ description: Describes pod anti-affinity scheduling
+ rules (e.g. avoid putting this pod in the same node,
+ zone, etc. as some other pod(s)).
properties:
preferredDuringSchedulingIgnoredDuringExecution:
- description: The scheduler will prefer to schedule pods to nodes that satisfy the anti-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 anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
+ description: The scheduler will prefer to schedule
+ pods to nodes that satisfy the anti-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
+ anti-affinity expressions, etc.), compute a
+ sum by iterating through the elements of this
+ field and adding "weight" to the sum if the
+ node has pods which matches the corresponding
+ podAffinityTerm; the node(s) with the highest
+ sum are the most preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched
+ WeightedPodAffinityTerm fields are added per-node
+ to find the most preferred node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated with the corresponding weight.
+ description: Required. A pod affinity term,
+ associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set
+ of resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is
+ a list of label selector requirements.
+ The requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector
+ requirement is a selector that
+ contains values, a key, and
+ an operator that relates the
+ key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to
+ a set of values. Valid operators
+ are In, NotIn, Exists and
+ DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5746,22 +9458,44 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which
+ namespaces the labelSelector applies
+ to (matches against); null or empty
+ list means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located
+ (affinity) or not co-located (anti-affinity)
+ with the pods matching the labelSelector
+ in the specified namespaces, where
+ co-located is defined as running on
+ a node whose value of the label with
+ key topologyKey matches that of any
+ node on which any of the selected
+ pods is running. Empty topologyKey
+ is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
+ description: weight associated with matching
+ the corresponding podAffinityTerm, in
+ the range 1-100.
format: int32
type: integer
required:
@@ -5770,26 +9504,61 @@
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
+ description: If the anti-affinity requirements
+ specified by this field are not met at scheduling
+ time, the pod will not be scheduled onto the
+ node. If the anti-affinity requirements specified
+ by this field cease to be met at some point
+ during pod execution (e.g. due to a pod label
+ update), the system may or may not try to eventually
+ evict the pod from its node. When there are
+ multiple elements, the lists of nodes corresponding
+ to each podAffinityTerm are intersected, i.e.
+ all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
+ description: Defines a set of pods (namely those
+ matching the labelSelector relative to the
+ given namespace(s)) that this pod should be
+ co-located (affinity) or not co-located (anti-affinity)
+ with, where co-located is defined as running
+ on a node whose value of the label with key
+ <topologyKey> matches that of any node on
+ which a pod of the set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of
+ resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The
+ requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a set
+ of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5801,16 +9570,34 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which
+ namespaces the labelSelector applies to
+ (matches against); null or empty list
+ means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located
+ (affinity) or not co-located (anti-affinity)
+ with the pods matching the labelSelector
+ in the specified namespaces, where co-located
+ is defined as running on a node whose
+ value of the label with key topologyKey
+ matches that of any node on which any
+ of the selected pods is running. Empty
+ topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -5821,21 +9608,34 @@
annotations:
additionalProperties:
type: string
- description: Annotations specifies the annotations to attach to zookeeper pods creates.
+ description: Annotations specifies the annotations to
+ attach to zookeeper pods creates.
type: object
env:
- description: List of environment variables to set in the main ZK container.
+ description: List of environment variables to set in the
+ main ZK container.
items:
- description: EnvVar represents an environment variable present in a Container.
+ description: EnvVar represents an environment variable
+ present in a Container.
properties:
name:
- description: Name of the environment variable. Must be a C_IDENTIFIER.
+ description: Name of the environment variable. Must
+ be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME) are
+ expanded using the previous 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.
+ The $(VAR_NAME) syntax can be escaped with a double
+ $$, ie: $$(VAR_NAME). Escaped references will
+ never be expanded, regardless of whether the variable
+ exists or not. Defaults to "".'
type: string
valueFrom:
- description: Source for the environment variable's value. Cannot be used if value is not empty.
+ description: Source for the environment variable's
+ value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -5844,37 +9644,54 @@
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key must be defined
+ description: Specify whether the ConfigMap
+ or its key must be defined
type: boolean
required:
- key
type: object
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.'
+ 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.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema the FieldPath
+ is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to select
+ in the specified API version.
type: string
required:
- fieldPath
type: object
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.'
+ 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.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required for
+ volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output format
+ of the exposed resources, defaults to
+ "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -5884,16 +9701,22 @@
- resource
type: object
secretKeyRef:
- description: Selects a key of a secret in the pod's namespace
+ description: Selects a key of a secret in the
+ pod's namespace
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select
+ from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret
+ or its key must be defined
type: boolean
required:
- key
@@ -5904,19 +9727,26 @@
type: object
type: array
imagePullSecrets:
- description: ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images
+ description: ImagePullSecrets is a list of references
+ to secrets in the same namespace to use for pulling
+ any images
items:
- description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
+ description: LocalObjectReference contains enough information
+ to let you locate the referenced object inside the
+ same namespace.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
type: object
type: array
labels:
additionalProperties:
type: string
- description: Labels specifies the labels to attach to pods the operator creates for the zookeeper cluster.
+ description: Labels specifies the labels to attach to
+ pods the operator creates for the zookeeper cluster.
type: object
nodeSelector:
additionalProperties:
@@ -5924,7 +9754,8 @@
description: Node Selector to be added on pods.
type: object
resources:
- description: Resources is the resource requirements for the Zookeeper container.
+ description: Resources is the resource requirements for
+ the Zookeeper container.
properties:
limits:
additionalProperties:
@@ -5933,7 +9764,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -5942,68 +9774,132 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
securityContext:
- description: 'SecurityContext specifies the security context for the entire zookeeper pod More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context'
+ description: 'SecurityContext specifies the security context
+ for the entire zookeeper pod More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context'
properties:
fsGroup:
- description: "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume."
+ description: "A special supplemental group that applies
+ to all containers in a pod. Some volume types allow
+ the Kubelet to change the ownership of that volume
+ to be owned by the pod: \n 1. The owning GID will
+ be the FSGroup 2. The setgid bit is set (new files
+ created in the volume will be owned by FSGroup)
+ 3. The permission bits are OR'd with rw-rw---- \n
+ If unset, the Kubelet will not modify the ownership
+ and permissions of any volume."
format: int64
type: integer
fsGroupChangePolicy:
- description: 'fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.'
+ description: 'fsGroupChangePolicy defines behavior
+ of changing ownership and permission of the volume
+ before being exposed inside Pod. This field will
+ only apply to volume types which support fsGroup
+ based ownership(and permissions). It will have no
+ effect on ephemeral volume types such as: secret,
+ configmaps and emptydir. Valid values are "OnRootMismatch"
+ and "Always". If not specified, "Always" is used.'
type: string
runAsGroup:
- description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The GID to run the entrypoint of the
+ container process. Uses runtime default if unset.
+ May also be set in SecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the value
+ specified in SecurityContext takes precedence for
+ that container.
format: int64
type: integer
runAsNonRoot:
- description: 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 SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: 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 SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The UID to run the entrypoint of the
+ container process. Defaults to user specified in
+ image metadata if unspecified. May also be set in
+ SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container.
format: int64
type: integer
seLinuxOptions:
- description: The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The SELinux context to be applied to
+ all containers. If unspecified, the container runtime
+ will allocate a random SELinux context for each
+ container. May also be set in SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence
+ for that container.
properties:
level:
- description: Level is SELinux level label that applies to the container.
+ description: Level is SELinux level label that
+ applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies to the container.
+ description: Role is a SELinux role label that
+ applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies to the container.
+ description: Type is a SELinux type label that
+ applies to the container.
type: string
user:
- description: User is a SELinux user label that applies to the container.
+ description: User is a SELinux user label that
+ applies to the container.
type: string
type: object
seccompProfile:
- description: The seccomp options to use by the containers in this pod.
+ description: The seccomp options to use by the containers
+ in this pod.
properties:
localhostProfile:
- description: 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 only be set if type is "Localhost".
+ description: 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 only be set if type is "Localhost".
type: string
type:
- description: "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."
+ description: "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."
type: string
required:
- type
type: object
supplementalGroups:
- description: A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.
+ description: A list of groups applied to the first
+ process run in each container, in addition to the
+ container's primary GID. If unspecified, no groups
+ will be added to any container.
items:
format: int64
type: integer
type: array
sysctls:
- description: Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.
+ description: Sysctls hold a list of namespaced sysctls
+ used for the pod. Pods with unsupported sysctls
+ (by the container runtime) might fail to launch.
items:
- description: Sysctl defines a kernel parameter to be set
+ description: Sysctl defines a kernel parameter to
+ be set
properties:
name:
description: Name of a property to set
@@ -6017,47 +9913,86 @@
type: object
type: array
windowsOptions:
- description: The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options within
+ a container's SecurityContext will be used. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
properties:
gmsaCredentialSpec:
- description: 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.
+ description: 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.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name
+ of the GMSA credential spec to use.
type: string
runAsUserName:
- description: 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.
+ description: 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.
type: string
type: object
type: object
serviceAccountName:
- description: Optional Service Account to run the zookeeper pods under.
+ description: Optional Service Account to run the zookeeper
+ pods under.
type: string
terminationGracePeriodSeconds:
- description: TerminationGracePeriodSeconds is the amount of time that kubernetes will give for a zookeeper pod instance to shutdown normally. The default value is 30.
+ description: TerminationGracePeriodSeconds is the amount
+ of time that kubernetes will give for a zookeeper pod
+ instance to shutdown normally. The default value is
+ 30.
format: int64
minimum: 0
type: integer
tolerations:
description: Tolerations to be added on pods.
items:
- description: The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
+ description: The pod this Toleration is attached to
+ tolerates any taint that matches the triple <key,value,effect>
+ using the matching operator <operator>.
properties:
effect:
- description: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
+ description: Effect indicates the taint effect to
+ match. Empty means match all taint effects. When
+ specified, allowed values are NoSchedule, PreferNoSchedule
+ and NoExecute.
type: string
key:
- description: Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
+ description: Key is the taint key that the toleration
+ applies to. Empty means match all taint keys.
+ If the key is empty, operator must be Exists;
+ this combination means to match all values and
+ all keys.
type: string
operator:
- description: Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
+ description: Operator represents a key's relationship
+ to the value. Valid operators are Exists and Equal.
+ Defaults to Equal. Exists is equivalent to wildcard
+ for value, so that a pod can tolerate all taints
+ of a particular category.
type: string
tolerationSeconds:
- description: TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
+ description: TolerationSeconds represents the period
+ of time the toleration (which must be of effect
+ NoExecute, otherwise this field is ignored) tolerates
+ the taint. By default, it is not set, which means
+ tolerate the taint forever (do not evict). Zero
+ and negative values will be treated as 0 (evict
+ immediately) by the system.
format: int64
type: integer
value:
- description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
+ description: Value is the taint value the toleration
+ matches to. If the operator is Exists, the value
+ should be empty, otherwise just a regular string.
type: string
type: object
type: array
@@ -6071,22 +10006,30 @@
backupRepositoriesAvailable:
additionalProperties:
type: boolean
- description: BackupRepositoriesAvailable lists the backupRepositories specified in the SolrCloud and whether they are available across all Pods.
+ description: BackupRepositoriesAvailable lists the backupRepositories
+ specified in the SolrCloud and whether they are available across
+ all Pods.
type: object
backupRestoreReady:
- description: BackupRestoreReady announces whether the solrCloud has the backupRestorePVC mounted to all pods and therefore is ready for backups and restores.
+ description: BackupRestoreReady announces whether the solrCloud has
+ the backupRestorePVC mounted to all pods and therefore is ready
+ for backups and restores.
type: boolean
externalCommonAddress:
- description: ExternalCommonAddress is the external common http address for all solr nodes. Will only be provided when an ingressUrl is provided for the cloud
+ description: ExternalCommonAddress is the external common http address
+ for all solr nodes. Will only be provided when an ingressUrl is
+ provided for the cloud
type: string
internalCommonAddress:
- description: InternalCommonAddress is the internal common http address for all solr nodes
+ description: InternalCommonAddress is the internal common http address
+ for all solr nodes
type: string
podSelector:
description: PodSelector for SolrCloud pods, required by the HPA
type: string
readyReplicas:
- description: ReadyReplicas is the number of ready replicas in the cluster
+ description: ReadyReplicas is the number of ready replicas in the
+ cluster
format: int32
type: integer
replicas:
@@ -6094,27 +10037,34 @@
format: int32
type: integer
solrNodes:
- description: SolrNodes contain the statuses of each solr node running in this solr cloud.
+ description: SolrNodes contain the statuses of each solr node running
+ in this solr cloud.
items:
- description: SolrNodeStatus is the status of a solrNode in the cloud, with readiness status and internal and external addresses
+ description: SolrNodeStatus is the status of a solrNode in the cloud,
+ with readiness status and internal and external addresses
properties:
externalAddress:
- description: An address the node can be connected to from outside of the Kube cluster Will only be provided when an ingressUrl is provided for the cloud
+ description: An address the node can be connected to from outside
+ of the Kube cluster Will only be provided when an ingressUrl
+ is provided for the cloud
type: string
internalAddress:
- description: An address the node can be connected to from within the Kube cluster
+ description: An address the node can be connected to from within
+ the Kube cluster
type: string
name:
description: The name of the pod running the node
type: string
nodeName:
- description: The name of the Kubernetes Node which the pod is running on
+ description: The name of the Kubernetes Node which the pod is
+ running on
type: string
ready:
description: Is the node up and running
type: boolean
specUpToDate:
- description: This Solr Node pod is using the latest version of solrcloud pod spec.
+ description: This Solr Node pod is using the latest version
+ of solrcloud pod spec.
type: boolean
version:
description: The version of solr that the node is running
@@ -6129,29 +10079,38 @@
type: object
type: array
targetVersion:
- description: The version of solr that the cloud is meant to be running. Will only be provided when the cloud is migrating between versions
+ description: The version of solr that the cloud is meant to be running.
+ Will only be provided when the cloud is migrating between versions
type: string
upToDateNodes:
- description: UpToDateNodes is the number of Solr Node pods that are running the latest pod spec
+ description: UpToDateNodes is the number of Solr Node pods that are
+ running the latest pod spec
format: int32
type: integer
version:
description: The version of solr that the cloud is running
type: string
zookeeperConnectionInfo:
- description: ZookeeperConnectionInfo is the information on how to connect to the used Zookeeper
+ description: ZookeeperConnectionInfo is the information on how to
+ connect to the used Zookeeper
properties:
acl:
- description: ZooKeeper ACL to use when connecting with ZK. This ACL should have ALL permission in the given chRoot.
+ description: ZooKeeper ACL to use when connecting with ZK. This
+ ACL should have ALL permission in the given chRoot.
properties:
passwordKey:
- description: The name of the key in the given secret that contains the ACL password
+ description: The name of the key in the given secret that
+ contains the ACL password
type: string
secret:
- description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
+ description: The name of the Kubernetes Secret that stores
+ the username and password for the ACL. This secret must
+ be in the same namespace as the solrCloud or prometheusExporter
+ is running in.
type: string
usernameKey:
- description: The name of the key in the given secret that contains the ACL username
+ description: The name of the key in the given secret that
+ contains the ACL username
type: string
required:
- passwordKey
@@ -6162,22 +10121,33 @@
description: The ChRoot to connect solr at
type: string
externalConnectionString:
- description: The connection string to connect to the ensemble from outside of the Kubernetes cluster If external and no internal connection string is provided, the external cnx string will be used as the internal cnx string
+ description: The connection string to connect to the ensemble
+ from outside of the Kubernetes cluster If external and no internal
+ connection string is provided, the external cnx string will
+ be used as the internal cnx string
type: string
internalConnectionString:
- description: The connection string to connect to the ensemble from within the Kubernetes cluster
+ description: The connection string to connect to the ensemble
+ from within the Kubernetes cluster
type: string
readOnlyAcl:
- description: ZooKeeper ACL to use when connecting with ZK for reading operations. This ACL should have READ permission in the given chRoot.
+ description: ZooKeeper ACL to use when connecting with ZK for
+ reading operations. This ACL should have READ permission in
+ the given chRoot.
properties:
passwordKey:
- description: The name of the key in the given secret that contains the ACL password
+ description: The name of the key in the given secret that
+ contains the ACL password
type: string
secret:
- description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
+ description: The name of the Kubernetes Secret that stores
+ the username and password for the ACL. This secret must
+ be in the same namespace as the solrCloud or prometheusExporter
+ is running in.
type: string
usernameKey:
- description: The name of the key in the given secret that contains the ACL username
+ description: The name of the key in the given secret that
+ contains the ACL username
type: string
required:
- passwordKey
diff --git a/config/crd/bases/solr.apache.org_solrprometheusexporters.yaml b/config/crd/bases/solr.apache.org_solrprometheusexporters.yaml
index ee68e54..18edae0 100644
--- a/config/crd/bases/solr.apache.org_solrprometheusexporters.yaml
+++ b/config/crd/bases/solr.apache.org_solrprometheusexporters.yaml
@@ -20,7 +20,7 @@
annotations:
operator.solr.apache.org/version: v0.7.0-prerelease
argocd.argoproj.io/sync-options: Replace=true
- controller-gen.kubebuilder.io/version: v0.5.0
+ controller-gen.kubebuilder.io/version: v0.6.0
creationTimestamp: null
name: solrprometheusexporters.solr.apache.org
spec:
@@ -49,13 +49,18 @@
name: v1beta1
schema:
openAPIV3Schema:
- description: SolrPrometheusExporter is the Schema for the solrprometheusexporters API
+ description: SolrPrometheusExporter is the Schema for the solrprometheusexporters
+ API
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -63,12 +68,15 @@
description: SolrPrometheusExporterSpec defines the desired state of SolrPrometheusExporter
properties:
busyBoxImage:
- description: An initContainer is needed to create a wrapper script around the exporter entrypoint when TLS is enabled with the `spec.solrReference.solrTLS.mountedTLSDir` option
+ description: An initContainer is needed to create a wrapper script
+ around the exporter entrypoint when TLS is enabled with the `spec.solrReference.solrTLS.mountedTLSDir`
+ option
properties:
imagePullSecret:
type: string
pullPolicy:
- description: PullPolicy describes a policy for if/when to pull a container image
+ description: PullPolicy describes a policy for if/when to pull
+ a container image
type: string
repository:
type: string
@@ -76,10 +84,12 @@
type: string
type: object
customKubeOptions:
- description: Provide custom options for kubernetes objects created for the SolrPrometheusExporter.
+ description: Provide custom options for kubernetes objects created
+ for the SolrPrometheusExporter.
properties:
configMapOptions:
- description: ServiceOptions defines the custom options for the solrPrometheusExporter ConfigMap.
+ description: ServiceOptions defines the custom options for the
+ solrPrometheusExporter ConfigMap.
properties:
annotations:
additionalProperties:
@@ -92,11 +102,13 @@
description: Labels to be added for the ConfigMap.
type: object
providedConfigMap:
- description: Name of a user provided ConfigMap in the same namespace containing a custom solr.xml
+ description: Name of a user provided ConfigMap in the same
+ namespace containing a custom solr.xml
type: string
type: object
deploymentOptions:
- description: DeploymentOptions defines the custom options for the solrPrometheusExporter Deployment.
+ description: DeploymentOptions defines the custom options for
+ the solrPrometheusExporter Deployment.
properties:
annotations:
additionalProperties:
@@ -110,35 +122,69 @@
type: object
type: object
podOptions:
- description: SolrPodOptions defines the custom options for the solrPrometheusExporter pods.
+ description: SolrPodOptions defines the custom options for the
+ solrPrometheusExporter pods.
properties:
affinity:
description: The scheduling constraints on pods.
properties:
nodeAffinity:
- description: Describes node affinity scheduling rules for the pod.
+ description: Describes node affinity scheduling rules
+ for the pod.
properties:
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.
+ 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.
items:
- 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).
+ 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).
properties:
preference:
- description: A node selector term, associated with the corresponding weight.
+ description: A node selector term, associated
+ with the corresponding weight.
properties:
matchExpressions:
- description: A list of node selector requirements by node's labels.
+ description: A list of node selector requirements
+ by node's labels.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that the
+ selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's relationship
+ to a set of values. Valid operators
+ are In, NotIn, Exists, DoesNotExist.
+ Gt, and Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -148,18 +194,35 @@
type: object
type: array
matchFields:
- description: A list of node selector requirements by node's fields.
+ description: A list of node selector requirements
+ by node's fields.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that the
+ selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's relationship
+ to a set of values. Valid operators
+ are In, NotIn, Exists, DoesNotExist.
+ Gt, and Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -170,7 +233,9 @@
type: array
type: object
weight:
- description: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
+ description: Weight associated with matching
+ the corresponding nodeSelectorTerm, in the
+ range 1-100.
format: int32
type: integer
required:
@@ -179,26 +244,53 @@
type: object
type: array
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.
+ 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.
properties:
nodeSelectorTerms:
- description: Required. A list of node selector terms. The terms are ORed.
+ description: Required. A list of node selector
+ terms. The terms are ORed.
items:
- 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.
+ 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.
properties:
matchExpressions:
- description: A list of node selector requirements by node's labels.
+ description: A list of node selector requirements
+ by node's labels.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that the
+ selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's relationship
+ to a set of values. Valid operators
+ are In, NotIn, Exists, DoesNotExist.
+ Gt, and Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -208,18 +300,35 @@
type: object
type: array
matchFields:
- description: A list of node selector requirements by node's fields.
+ description: A list of node selector requirements
+ by node's fields.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that the
+ selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's relationship
+ to a set of values. Valid operators
+ are In, NotIn, Exists, DoesNotExist.
+ Gt, and Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -235,32 +344,67 @@
type: object
type: object
podAffinity:
- description: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
+ description: Describes pod affinity scheduling rules (e.g.
+ co-locate this pod in the same node, zone, etc. as some
+ other pod(s)).
properties:
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 has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
+ 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 has pods which matches the corresponding
+ podAffinityTerm; the node(s) with the highest sum
+ are the most preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched WeightedPodAffinityTerm
+ fields are added per-node to find the most preferred
+ node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated with the corresponding weight.
+ description: Required. A pod affinity term,
+ associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of
+ resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The
+ requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a set
+ of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -272,22 +416,42 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which
+ namespaces the labelSelector applies to
+ (matches against); null or empty list
+ means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located
+ (affinity) or not co-located (anti-affinity)
+ with the pods matching the labelSelector
+ in the specified namespaces, where co-located
+ is defined as running on a node whose
+ value of the label with key topologyKey
+ matches that of any node on which any
+ of the selected pods is running. Empty
+ topologyKey is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
+ description: weight associated with matching
+ the corresponding podAffinityTerm, in the
+ range 1-100.
format: int32
type: integer
required:
@@ -296,26 +460,59 @@
type: object
type: array
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 a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
+ 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 a pod label update), the system may or may
+ not try to eventually evict the pod from its node.
+ When there are multiple elements, the lists of nodes
+ corresponding to each podAffinityTerm are intersected,
+ i.e. all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
+ description: Defines a set of pods (namely those
+ matching the labelSelector relative to the given
+ namespace(s)) that this pod should be co-located
+ (affinity) or not co-located (anti-affinity) with,
+ where co-located is defined as running on a node
+ whose value of the label with key <topologyKey>
+ matches that of any node on which a pod of the
+ set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of resources,
+ in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The requirements
+ are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label key
+ that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a
+ key's relationship to a set of values.
+ Valid operators are In, NotIn, Exists
+ and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -327,16 +524,30 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which namespaces
+ the labelSelector applies to (matches against);
+ null or empty list means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity)
+ or not co-located (anti-affinity) with the
+ pods matching the labelSelector in the specified
+ namespaces, where co-located is defined as
+ running on a node whose value of the label
+ with key topologyKey matches that of any node
+ on which any of the selected pods is running.
+ Empty topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -344,32 +555,67 @@
type: array
type: object
podAntiAffinity:
- description: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
+ description: Describes pod anti-affinity scheduling rules
+ (e.g. avoid putting this pod in the same node, zone,
+ etc. as some other pod(s)).
properties:
preferredDuringSchedulingIgnoredDuringExecution:
- description: The scheduler will prefer to schedule pods to nodes that satisfy the anti-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 anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
+ description: The scheduler will prefer to schedule
+ pods to nodes that satisfy the anti-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 anti-affinity
+ expressions, etc.), compute a sum by iterating through
+ the elements of this field and adding "weight" to
+ the sum if the node has pods which matches the corresponding
+ podAffinityTerm; the node(s) with the highest sum
+ are the most preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched WeightedPodAffinityTerm
+ fields are added per-node to find the most preferred
+ node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated with the corresponding weight.
+ description: Required. A pod affinity term,
+ associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of
+ resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The
+ requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a set
+ of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -381,22 +627,42 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which
+ namespaces the labelSelector applies to
+ (matches against); null or empty list
+ means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located
+ (affinity) or not co-located (anti-affinity)
+ with the pods matching the labelSelector
+ in the specified namespaces, where co-located
+ is defined as running on a node whose
+ value of the label with key topologyKey
+ matches that of any node on which any
+ of the selected pods is running. Empty
+ topologyKey is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
+ description: weight associated with matching
+ the corresponding podAffinityTerm, in the
+ range 1-100.
format: int32
type: integer
required:
@@ -405,26 +671,59 @@
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
+ description: If the anti-affinity requirements specified
+ by this field are not met at scheduling time, the
+ pod will not be scheduled onto the node. If the
+ anti-affinity requirements specified by this field
+ cease to be met at some point during pod execution
+ (e.g. due to a pod label update), the system may
+ or may not try to eventually evict the pod from
+ its node. When there are multiple elements, the
+ lists of nodes corresponding to each podAffinityTerm
+ are intersected, i.e. all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
+ description: Defines a set of pods (namely those
+ matching the labelSelector relative to the given
+ namespace(s)) that this pod should be co-located
+ (affinity) or not co-located (anti-affinity) with,
+ where co-located is defined as running on a node
+ whose value of the label with key <topologyKey>
+ matches that of any node on which a pod of the
+ set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of resources,
+ in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The requirements
+ are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label key
+ that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a
+ key's relationship to a set of values.
+ Valid operators are In, NotIn, Exists
+ and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -436,16 +735,30 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which namespaces
+ the labelSelector applies to (matches against);
+ null or empty list means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity)
+ or not co-located (anti-affinity) with the
+ pods matching the labelSelector in the specified
+ namespaces, where co-located is defined as
+ running on a node whose value of the label
+ with key topologyKey matches that of any node
+ on which any of the selected pods is running.
+ Empty topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -459,7 +772,9 @@
description: Annotations to be added for pods.
type: object
defaultInitContainerResources:
- description: DefaultInitContainerResources are the resource requirements for the default init container(s) created by the Solr Operator, if any are created.
+ description: DefaultInitContainerResources are the resource
+ requirements for the default init container(s) created by
+ the Solr Operator, if any are created.
properties:
limits:
additionalProperties:
@@ -468,7 +783,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount of compute
+ resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -477,22 +793,38 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
envVars:
- description: Additional environment variables to pass to the default container.
+ description: Additional environment variables to pass to the
+ default container.
items:
- description: EnvVar represents an environment variable present in a Container.
+ description: EnvVar represents an environment variable present
+ in a Container.
properties:
name:
- description: Name of the environment variable. Must be a C_IDENTIFIER.
+ description: Name of the environment variable. Must
+ be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME) are expanded
+ using the previous 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. The $(VAR_NAME)
+ syntax can be escaped with a double $$, ie: $$(VAR_NAME).
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Defaults to
+ "".'
type: string
valueFrom:
- description: Source for the environment variable's value. Cannot be used if value is not empty.
+ description: Source for the environment variable's value.
+ Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -501,37 +833,53 @@
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key must be defined
+ description: Specify whether the ConfigMap or
+ its key must be defined
type: boolean
required:
- key
type: object
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.'
+ 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.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema the FieldPath
+ is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to select in
+ the specified API version.
type: string
required:
- fieldPath
type: object
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.'
+ 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.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required for volumes,
+ optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output format of
+ the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -541,16 +889,22 @@
- resource
type: object
secretKeyRef:
- description: Selects a key of a secret in the pod's namespace
+ description: Selects a key of a secret in the pod's
+ namespace
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select
+ from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its
+ key must be defined
type: boolean
required:
- key
@@ -561,43 +915,80 @@
type: object
type: array
imagePullSecrets:
- description: ImagePullSecrets to apply to the pod. These are for init/sidecarContainers in addition to the imagePullSecret defined for the solr image.
+ description: ImagePullSecrets to apply to the pod. These are
+ for init/sidecarContainers in addition to the imagePullSecret
+ defined for the solr image.
items:
- description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
+ description: LocalObjectReference contains enough information
+ to let you locate the referenced object inside the same
+ namespace.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
type: array
initContainers:
- description: Additional init containers to run in the pod. These will run along with the init container that sets up the "solr.xml".
+ description: Additional init containers to run in the pod.
+ These will run along with the init container that sets up
+ the "solr.xml".
items:
- description: A single application container that you want to run within a pod.
+ description: A single application container that you want
+ to run within a pod.
properties:
args:
- description: 'Arguments to the entrypoint. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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'
+ description: 'Arguments to the entrypoint. The docker
+ 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. The
+ $(VAR_NAME) syntax can be escaped with a double $$,
+ ie: $$(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'
items:
type: string
type: array
command:
- description: 'Entrypoint array. Not executed within a shell. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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'
+ description: 'Entrypoint array. Not executed within
+ a shell. The docker 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. The $(VAR_NAME) syntax
+ can be escaped with a double $$, ie: $$(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'
items:
type: string
type: array
env:
- description: List of environment variables to set in the container. Cannot be updated.
+ description: List of environment variables to set in
+ the container. Cannot be updated.
items:
- description: EnvVar represents an environment variable present in a Container.
+ description: EnvVar represents an environment variable
+ present in a Container.
properties:
name:
- description: Name of the environment variable. Must be a C_IDENTIFIER.
+ description: Name of the environment variable.
+ Must be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previous 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.
+ The $(VAR_NAME) syntax can be escaped with a
+ double $$, ie: $$(VAR_NAME). Escaped references
+ will never be expanded, regardless of whether
+ the variable exists or not. Defaults to "".'
type: string
valueFrom:
- description: Source for the environment variable's value. Cannot be used if value is not empty.
+ description: Source for the environment variable's
+ value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -606,37 +997,55 @@
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key must be defined
+ description: Specify whether the ConfigMap
+ or its key must be defined
type: boolean
required:
- key
type: object
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.'
+ 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.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema the
+ FieldPath is written in terms of, defaults
+ to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to select
+ in the specified API version.
type: string
required:
- fieldPath
type: object
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.'
+ 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.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required
+ for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output format
+ of the exposed resources, defaults to
+ "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -646,16 +1055,23 @@
- resource
type: object
secretKeyRef:
- description: Selects a key of a secret in the pod's namespace
+ description: Selects a key of a secret in
+ the pod's namespace
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to
+ select from. Must be a valid secret
+ key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret
+ or its key must be defined
type: boolean
required:
- key
@@ -666,66 +1082,112 @@
type: object
type: array
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.
+ 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.
items:
- description: EnvFromSource represents the source of a set of ConfigMaps
+ description: EnvFromSource represents the source of
+ a set of ConfigMaps
properties:
configMapRef:
description: The ConfigMap to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap must be defined
+ description: Specify whether the ConfigMap
+ must be defined
type: boolean
type: object
prefix:
- description: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ description: An optional identifier to prepend
+ to each key in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
description: The Secret to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret must be defined
+ description: Specify whether the Secret must
+ be defined
type: boolean
type: object
type: object
type: array
image:
- description: 'Docker 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.'
+ description: 'Docker 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.'
type: string
imagePullPolicy:
- description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
+ description: 'Image pull policy. One of Always, Never,
+ IfNotPresent. Defaults to Always if :latest tag is
+ specified, or IfNotPresent otherwise. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
+ description: Actions that the management system should
+ take in response to container lifecycle events. Cannot
+ be updated.
properties:
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following
+ should be specified. Exec specifies the action
+ to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
+ "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the
+ request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -739,58 +1201,99 @@
type: object
type: array
path:
- description: Path to access on the HTTP server.
+ description: Path to access on the HTTP
+ server.
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action
+ involving a TCP port. TCP hooks not yet supported
+ TODO: implement a realistic TCP lifecycle
+ hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
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 reason for termination is passed to the handler. The Pod''s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period. 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'
+ 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 reason for termination is passed
+ to the handler. The Pod''s termination grace period
+ countdown begins before the PreStop hooked is
+ executed. Regardless of the outcome of the handler,
+ the container will eventually terminate within
+ the Pod''s termination grace period. 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following
+ should be specified. Exec specifies the action
+ to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
+ "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the
+ request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -804,31 +1307,43 @@
type: object
type: array
path:
- description: Path to access on the HTTP server.
+ description: Path to access on the HTTP
+ server.
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action
+ involving a TCP port. TCP hooks not yet supported
+ TODO: implement a realistic TCP lifecycle
+ hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
@@ -836,31 +1351,49 @@
type: object
type: object
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -880,71 +1413,109 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
name:
- description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
+ description: Name of the container specified as a DNS_LABEL.
+ Each container in a pod must have a unique name (DNS_LABEL).
+ Cannot be updated.
type: string
ports:
- description: List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. Cannot be updated.
+ description: List of ports to expose from the container.
+ Exposing a port here gives the system additional information
+ about the network connections a container uses, but
+ is primarily informational. 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. Cannot be updated.
items:
- description: ContainerPort represents a network port in a single container.
+ description: ContainerPort represents a network port
+ in a single container.
properties:
containerPort:
- description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's
+ IP address. This must be a valid port number,
+ 0 < x < 65536.
format: int32
type: integer
hostIP:
- description: What host IP to bind the external port to.
+ description: What host IP to bind the external
+ port to.
type: string
hostPort:
- description: 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 do not need this.
+ description: 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
+ do not need this.
format: int32
type: integer
name:
- description: 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.
+ description: 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.
type: string
protocol:
default: TCP
- description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP,
+ or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -955,31 +1526,49 @@
- protocol
x-kubernetes-list-type: map
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -999,48 +1588,66 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
resources:
- description: 'Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Compute Resources required by this container.
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
properties:
limits:
additionalProperties:
@@ -1049,7 +1656,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -1058,119 +1666,221 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
securityContext:
- description: 'Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
+ description: 'Security options the pod should run with.
+ More info: https://kubernetes.io/docs/concepts/policy/security-context/
+ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: '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'
+ description: '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'
type: boolean
capabilities:
- description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
+ description: The capabilities to add/drop when running
+ containers. Defaults to the default set of capabilities
+ granted by the container runtime.
properties:
add:
description: Added capabilities
items:
- description: Capability represent POSIX capabilities type
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
drop:
description: Removed capabilities
items:
- description: Capability represent POSIX capabilities type
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
type: object
privileged:
- description: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
+ description: Run container in privileged mode. Processes
+ in privileged containers are essentially equivalent
+ to root on the host. Defaults to false.
type: boolean
procMount:
- description: 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.
+ description: 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.
type: string
readOnlyRootFilesystem:
- description: Whether this container has a read-only root filesystem. Default is false.
+ description: Whether this container has a read-only
+ root filesystem. Default is false.
type: boolean
runAsGroup:
- description: 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.
+ description: 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.
format: int64
type: integer
runAsNonRoot:
- description: 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.
+ description: 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.
type: boolean
runAsUser:
- description: 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.
+ description: 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.
format: int64
type: integer
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.
+ 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.
properties:
level:
- description: Level is SELinux level label that applies to the container.
+ description: Level is SELinux level label that
+ applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies to the container.
+ description: Role is a SELinux role label that
+ applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies to the container.
+ description: Type is a SELinux type label that
+ applies to the container.
type: string
user:
- description: User is a SELinux user label that applies to the container.
+ description: User is a SELinux user label that
+ applies to the container.
type: string
type: object
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.
+ 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.
properties:
localhostProfile:
- description: 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 only be set if type is "Localhost".
+ description: 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 only be set if type is "Localhost".
type: string
type:
- description: "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."
+ description: "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."
type: string
required:
- type
type: object
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.
+ 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.
properties:
gmsaCredentialSpec:
- description: 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.
+ description: 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.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name
+ of the GMSA credential spec to use.
type: string
runAsUserName:
- description: 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.
+ description: 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.
type: string
type: object
type: object
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1190,71 +1900,124 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
stdin:
- description: 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.
+ description: 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.
type: boolean
stdinOnce:
- description: 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
+ description: 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
type: boolean
terminationMessagePath:
- description: 'Optional: Path at which the file to which the container''s termination message will be written is mounted into the container''s filesystem. 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.'
+ description: 'Optional: Path at which the file to which
+ the container''s termination message will be written
+ is mounted into the container''s filesystem. 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.'
type: string
terminationMessagePolicy:
- description: 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.
+ description: 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.
type: string
tty:
- description: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be true.
+ Default is false.
type: boolean
volumeDevices:
- description: volumeDevices is the list of block devices to be used by the container.
+ description: volumeDevices is the list of block devices
+ to be used by the container.
items:
- description: volumeDevice describes a mapping of a raw block device within a container.
+ description: volumeDevice describes a mapping of a
+ raw block device within a container.
properties:
devicePath:
- description: devicePath is the path inside of the container that the device will be mapped to.
+ description: devicePath is the path inside of
+ the container that the device will be mapped
+ to.
type: string
name:
- description: name must match the name of a persistentVolumeClaim in the pod
+ description: name must match the name of a persistentVolumeClaim
+ in the pod
type: string
required:
- devicePath
@@ -1262,27 +2025,44 @@
type: object
type: array
volumeMounts:
- description: Pod volumes to mount into the container's filesystem. Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
- description: VolumeMount describes a mounting of a Volume within a container.
+ description: VolumeMount describes a mounting of a
+ Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume should be mounted. Must not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: 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.
+ description: 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.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which
+ the container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: 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.
+ description: 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.
type: string
required:
- mountPath
@@ -1290,7 +2070,10 @@
type: object
type: array
workingDir:
- description: 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.
+ description: 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.
type: string
required:
- name
@@ -1305,27 +2088,45 @@
description: Lifecycle for the main container
properties:
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request to
+ perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1345,52 +2146,85 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the
+ host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to,
+ defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
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 reason for termination is passed to the handler. The Pod''s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period. 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'
+ 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 reason for termination
+ is passed to the handler. The Pod''s termination grace
+ period countdown begins before the PreStop hooked is
+ executed. Regardless of the outcome of the handler,
+ the container will eventually terminate within the Pod''s
+ termination grace period. 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request to
+ perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1410,25 +2244,33 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the
+ host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to,
+ defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
@@ -1439,28 +2281,42 @@
description: Liveness probe parameters
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe
+ to be considered failed after having succeeded. Defaults
+ to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults to
+ the pod IP. You probably want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1480,43 +2336,59 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host.
+ Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe.
+ Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults
+ to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
@@ -1526,64 +2398,122 @@
description: Node Selector to be added for the StatefulSet.
type: object
podSecurityContext:
- description: PodSecurityContext is the security context for the pod.
+ description: PodSecurityContext is the security context for
+ the pod.
properties:
fsGroup:
- description: "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume."
+ description: "A special supplemental group that applies
+ to all containers in a pod. Some volume types allow
+ the Kubelet to change the ownership of that volume to
+ be owned by the pod: \n 1. The owning GID will be the
+ FSGroup 2. The setgid bit is set (new files created
+ in the volume will be owned by FSGroup) 3. The permission
+ bits are OR'd with rw-rw---- \n If unset, the Kubelet
+ will not modify the ownership and permissions of any
+ volume."
format: int64
type: integer
fsGroupChangePolicy:
- description: 'fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.'
+ description: 'fsGroupChangePolicy defines behavior of
+ changing ownership and permission of the volume before
+ being exposed inside Pod. This field will only apply
+ to volume types which support fsGroup based ownership(and
+ permissions). It will have no effect on ephemeral volume
+ types such as: secret, configmaps and emptydir. Valid
+ values are "OnRootMismatch" and "Always". If not specified,
+ "Always" is used.'
type: string
runAsGroup:
- description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The GID to run the entrypoint of the container
+ process. Uses runtime default if unset. May also be
+ set in SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container.
format: int64
type: integer
runAsNonRoot:
- description: 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 SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: 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 SecurityContext. If set
+ in both SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The UID to run the entrypoint of the container
+ process. Defaults to user specified in image metadata
+ if unspecified. May also be set in SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence
+ for that container.
format: int64
type: integer
seLinuxOptions:
- description: The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The SELinux context to be applied to all
+ containers. If unspecified, the container runtime will
+ allocate a random SELinux context for each container. May
+ also be set in SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container.
properties:
level:
- description: Level is SELinux level label that applies to the container.
+ description: Level is SELinux level label that applies
+ to the container.
type: string
role:
- description: Role is a SELinux role label that applies to the container.
+ description: Role is a SELinux role label that applies
+ to the container.
type: string
type:
- description: Type is a SELinux type label that applies to the container.
+ description: Type is a SELinux type label that applies
+ to the container.
type: string
user:
- description: User is a SELinux user label that applies to the container.
+ description: User is a SELinux user label that applies
+ to the container.
type: string
type: object
seccompProfile:
- description: The seccomp options to use by the containers in this pod.
+ description: The seccomp options to use by the containers
+ in this pod.
properties:
localhostProfile:
- description: 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 only be set if type is "Localhost".
+ description: 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 only be
+ set if type is "Localhost".
type: string
type:
- description: "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."
+ description: "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."
type: string
required:
- type
type: object
supplementalGroups:
- description: A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.
+ description: A list of groups applied to the first process
+ run in each container, in addition to the container's
+ primary GID. If unspecified, no groups will be added
+ to any container.
items:
format: int64
type: integer
type: array
sysctls:
- description: Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.
+ description: Sysctls hold a list of namespaced sysctls
+ used for the pod. Pods with unsupported sysctls (by
+ the container runtime) might fail to launch.
items:
- description: Sysctl defines a kernel parameter to be set
+ description: Sysctl defines a kernel parameter to be
+ set
properties:
name:
description: Name of a property to set
@@ -1597,16 +2527,29 @@
type: object
type: array
windowsOptions:
- description: The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The Windows specific settings applied to
+ all containers. If unspecified, the options within a
+ container's SecurityContext will be used. If set in
+ both SecurityContext and PodSecurityContext, the value
+ specified in SecurityContext takes precedence.
properties:
gmsaCredentialSpec:
- description: 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.
+ description: 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.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name of
+ the GMSA credential spec to use.
type: string
runAsUserName:
- description: 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.
+ description: 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.
type: string
type: object
type: object
@@ -1617,28 +2560,42 @@
description: Readiness probe parameters
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe
+ to be considered failed after having succeeded. Defaults
+ to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults to
+ the pod IP. You probably want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1658,48 +2615,65 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host.
+ Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe.
+ Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults
+ to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
resources:
- description: Resources is the resource requirements for the default container.
+ description: Resources is the resource requirements for the
+ default container.
properties:
limits:
additionalProperties:
@@ -1708,7 +2682,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount of compute
+ resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -1717,40 +2692,75 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
serviceAccountName:
description: Optional Service Account to run the pod under.
type: string
sidecarContainers:
- description: Sidecar containers to run in the pod. These are in addition to the Solr Container
+ description: Sidecar containers to run in the pod. These are
+ in addition to the Solr Container
items:
- description: A single application container that you want to run within a pod.
+ description: A single application container that you want
+ to run within a pod.
properties:
args:
- description: 'Arguments to the entrypoint. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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'
+ description: 'Arguments to the entrypoint. The docker
+ 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. The
+ $(VAR_NAME) syntax can be escaped with a double $$,
+ ie: $$(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'
items:
type: string
type: array
command:
- description: 'Entrypoint array. Not executed within a shell. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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'
+ description: 'Entrypoint array. Not executed within
+ a shell. The docker 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. The $(VAR_NAME) syntax
+ can be escaped with a double $$, ie: $$(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'
items:
type: string
type: array
env:
- description: List of environment variables to set in the container. Cannot be updated.
+ description: List of environment variables to set in
+ the container. Cannot be updated.
items:
- description: EnvVar represents an environment variable present in a Container.
+ description: EnvVar represents an environment variable
+ present in a Container.
properties:
name:
- description: Name of the environment variable. Must be a C_IDENTIFIER.
+ description: Name of the environment variable.
+ Must be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previous 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.
+ The $(VAR_NAME) syntax can be escaped with a
+ double $$, ie: $$(VAR_NAME). Escaped references
+ will never be expanded, regardless of whether
+ the variable exists or not. Defaults to "".'
type: string
valueFrom:
- description: Source for the environment variable's value. Cannot be used if value is not empty.
+ description: Source for the environment variable's
+ value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -1759,37 +2769,55 @@
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key must be defined
+ description: Specify whether the ConfigMap
+ or its key must be defined
type: boolean
required:
- key
type: object
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.'
+ 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.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema the
+ FieldPath is written in terms of, defaults
+ to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to select
+ in the specified API version.
type: string
required:
- fieldPath
type: object
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.'
+ 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.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required
+ for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output format
+ of the exposed resources, defaults to
+ "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -1799,16 +2827,23 @@
- resource
type: object
secretKeyRef:
- description: Selects a key of a secret in the pod's namespace
+ description: Selects a key of a secret in
+ the pod's namespace
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to
+ select from. Must be a valid secret
+ key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret
+ or its key must be defined
type: boolean
required:
- key
@@ -1819,66 +2854,112 @@
type: object
type: array
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.
+ 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.
items:
- description: EnvFromSource represents the source of a set of ConfigMaps
+ description: EnvFromSource represents the source of
+ a set of ConfigMaps
properties:
configMapRef:
description: The ConfigMap to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap must be defined
+ description: Specify whether the ConfigMap
+ must be defined
type: boolean
type: object
prefix:
- description: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ description: An optional identifier to prepend
+ to each key in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
description: The Secret to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret must be defined
+ description: Specify whether the Secret must
+ be defined
type: boolean
type: object
type: object
type: array
image:
- description: 'Docker 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.'
+ description: 'Docker 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.'
type: string
imagePullPolicy:
- description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
+ description: 'Image pull policy. One of Always, Never,
+ IfNotPresent. Defaults to Always if :latest tag is
+ specified, or IfNotPresent otherwise. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
+ description: Actions that the management system should
+ take in response to container lifecycle events. Cannot
+ be updated.
properties:
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following
+ should be specified. Exec specifies the action
+ to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
+ "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the
+ request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1892,58 +2973,99 @@
type: object
type: array
path:
- description: Path to access on the HTTP server.
+ description: Path to access on the HTTP
+ server.
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action
+ involving a TCP port. TCP hooks not yet supported
+ TODO: implement a realistic TCP lifecycle
+ hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
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 reason for termination is passed to the handler. The Pod''s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period. 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'
+ 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 reason for termination is passed
+ to the handler. The Pod''s termination grace period
+ countdown begins before the PreStop hooked is
+ executed. Regardless of the outcome of the handler,
+ the container will eventually terminate within
+ the Pod''s termination grace period. 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following
+ should be specified. Exec specifies the action
+ to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
+ "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the
+ request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -1957,31 +3079,43 @@
type: object
type: array
path:
- description: Path to access on the HTTP server.
+ description: Path to access on the HTTP
+ server.
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action
+ involving a TCP port. TCP hooks not yet supported
+ TODO: implement a realistic TCP lifecycle
+ hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
@@ -1989,31 +3123,49 @@
type: object
type: object
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2033,71 +3185,109 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
name:
- description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
+ description: Name of the container specified as a DNS_LABEL.
+ Each container in a pod must have a unique name (DNS_LABEL).
+ Cannot be updated.
type: string
ports:
- description: List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. Cannot be updated.
+ description: List of ports to expose from the container.
+ Exposing a port here gives the system additional information
+ about the network connections a container uses, but
+ is primarily informational. 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. Cannot be updated.
items:
- description: ContainerPort represents a network port in a single container.
+ description: ContainerPort represents a network port
+ in a single container.
properties:
containerPort:
- description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's
+ IP address. This must be a valid port number,
+ 0 < x < 65536.
format: int32
type: integer
hostIP:
- description: What host IP to bind the external port to.
+ description: What host IP to bind the external
+ port to.
type: string
hostPort:
- description: 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 do not need this.
+ description: 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
+ do not need this.
format: int32
type: integer
name:
- description: 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.
+ description: 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.
type: string
protocol:
default: TCP
- description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP,
+ or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -2108,31 +3298,49 @@
- protocol
x-kubernetes-list-type: map
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2152,48 +3360,66 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
resources:
- description: 'Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Compute Resources required by this container.
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
properties:
limits:
additionalProperties:
@@ -2202,7 +3428,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -2211,119 +3438,221 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
securityContext:
- description: 'Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
+ description: 'Security options the pod should run with.
+ More info: https://kubernetes.io/docs/concepts/policy/security-context/
+ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: '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'
+ description: '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'
type: boolean
capabilities:
- description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
+ description: The capabilities to add/drop when running
+ containers. Defaults to the default set of capabilities
+ granted by the container runtime.
properties:
add:
description: Added capabilities
items:
- description: Capability represent POSIX capabilities type
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
drop:
description: Removed capabilities
items:
- description: Capability represent POSIX capabilities type
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
type: object
privileged:
- description: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
+ description: Run container in privileged mode. Processes
+ in privileged containers are essentially equivalent
+ to root on the host. Defaults to false.
type: boolean
procMount:
- description: 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.
+ description: 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.
type: string
readOnlyRootFilesystem:
- description: Whether this container has a read-only root filesystem. Default is false.
+ description: Whether this container has a read-only
+ root filesystem. Default is false.
type: boolean
runAsGroup:
- description: 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.
+ description: 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.
format: int64
type: integer
runAsNonRoot:
- description: 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.
+ description: 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.
type: boolean
runAsUser:
- description: 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.
+ description: 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.
format: int64
type: integer
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.
+ 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.
properties:
level:
- description: Level is SELinux level label that applies to the container.
+ description: Level is SELinux level label that
+ applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies to the container.
+ description: Role is a SELinux role label that
+ applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies to the container.
+ description: Type is a SELinux type label that
+ applies to the container.
type: string
user:
- description: User is a SELinux user label that applies to the container.
+ description: User is a SELinux user label that
+ applies to the container.
type: string
type: object
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.
+ 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.
properties:
localhostProfile:
- description: 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 only be set if type is "Localhost".
+ description: 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 only be set if type is "Localhost".
type: string
type:
- description: "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."
+ description: "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."
type: string
required:
- type
type: object
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.
+ 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.
properties:
gmsaCredentialSpec:
- description: 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.
+ description: 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.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name
+ of the GMSA credential spec to use.
type: string
runAsUserName:
- description: 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.
+ description: 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.
type: string
type: object
type: object
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2343,71 +3672,124 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
stdin:
- description: 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.
+ description: 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.
type: boolean
stdinOnce:
- description: 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
+ description: 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
type: boolean
terminationMessagePath:
- description: 'Optional: Path at which the file to which the container''s termination message will be written is mounted into the container''s filesystem. 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.'
+ description: 'Optional: Path at which the file to which
+ the container''s termination message will be written
+ is mounted into the container''s filesystem. 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.'
type: string
terminationMessagePolicy:
- description: 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.
+ description: 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.
type: string
tty:
- description: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be true.
+ Default is false.
type: boolean
volumeDevices:
- description: volumeDevices is the list of block devices to be used by the container.
+ description: volumeDevices is the list of block devices
+ to be used by the container.
items:
- description: volumeDevice describes a mapping of a raw block device within a container.
+ description: volumeDevice describes a mapping of a
+ raw block device within a container.
properties:
devicePath:
- description: devicePath is the path inside of the container that the device will be mapped to.
+ description: devicePath is the path inside of
+ the container that the device will be mapped
+ to.
type: string
name:
- description: name must match the name of a persistentVolumeClaim in the pod
+ description: name must match the name of a persistentVolumeClaim
+ in the pod
type: string
required:
- devicePath
@@ -2415,27 +3797,44 @@
type: object
type: array
volumeMounts:
- description: Pod volumes to mount into the container's filesystem. Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
- description: VolumeMount describes a mounting of a Volume within a container.
+ description: VolumeMount describes a mounting of a
+ Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume should be mounted. Must not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: 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.
+ description: 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.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which
+ the container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: 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.
+ description: 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.
type: string
required:
- mountPath
@@ -2443,7 +3842,10 @@
type: object
type: array
workingDir:
- description: 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.
+ description: 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.
type: string
required:
- name
@@ -2453,28 +3855,42 @@
description: Startup probe parameters
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe
+ to be considered failed after having succeeded. Defaults
+ to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults to
+ the pod IP. You probably want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2494,95 +3910,149 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host.
+ Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe.
+ Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults
+ to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs to terminate gracefully.
+ description: Optional duration in seconds the pod needs to
+ terminate gracefully.
format: int64
minimum: 10
type: integer
tolerations:
description: Tolerations to be added for the StatefulSet.
items:
- description: The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
+ description: The pod this Toleration is attached to tolerates
+ any taint that matches the triple <key,value,effect> using
+ the matching operator <operator>.
properties:
effect:
- description: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
+ description: Effect indicates the taint effect to match.
+ Empty means match all taint effects. When specified,
+ allowed values are NoSchedule, PreferNoSchedule and
+ NoExecute.
type: string
key:
- description: Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
+ description: Key is the taint key that the toleration
+ applies to. Empty means match all taint keys. If the
+ key is empty, operator must be Exists; this combination
+ means to match all values and all keys.
type: string
operator:
- description: Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
+ description: Operator represents a key's relationship
+ to the value. Valid operators are Exists and Equal.
+ Defaults to Equal. Exists is equivalent to wildcard
+ for value, so that a pod can tolerate all taints of
+ a particular category.
type: string
tolerationSeconds:
- description: TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
+ description: TolerationSeconds represents the period
+ of time the toleration (which must be of effect NoExecute,
+ otherwise this field is ignored) tolerates the taint.
+ By default, it is not set, which means tolerate the
+ taint forever (do not evict). Zero and negative values
+ will be treated as 0 (evict immediately) by the system.
format: int64
type: integer
value:
- description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
+ description: Value is the taint value the toleration
+ matches to. If the operator is Exists, the value should
+ be empty, otherwise just a regular string.
type: string
type: object
type: array
topologySpreadConstraints:
- description: "Optional PodSpreadTopologyConstraints to use when scheduling pods. More information here: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ \n Note: There is no need to provide a \"labelSelector\", as the operator will inject the labels for you if not provided."
+ description: "Optional PodSpreadTopologyConstraints to use
+ when scheduling pods. More information here: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
+ \n Note: There is no need to provide a \"labelSelector\",
+ as the operator will inject the labels for you if not provided."
items:
- description: TopologySpreadConstraint specifies how to spread matching pods among the given topology.
+ description: TopologySpreadConstraint specifies how to spread
+ matching pods among the given topology.
properties:
labelSelector:
- description: LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
+ description: LabelSelector is used to find matching
+ pods. Pods that match this label selector are counted
+ to determine the number of pods in their corresponding
+ topology domain.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label
+ selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement is a
+ selector that contains values, a key, and an
+ operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label key that the
+ selector applies to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship
+ to a set of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -2594,18 +4064,59 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
maxSkew:
- description: 'MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It''s a required field. Default value is 1 and 0 is not allowed.'
+ description: 'MaxSkew describes the degree to which
+ pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`,
+ it is the maximum permitted difference between the
+ number of matching pods in the target topology and
+ the global minimum. For example, in a 3-zone cluster,
+ MaxSkew is set to 1, and pods with the same labelSelector
+ spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | |
+ - if MaxSkew is 1, incoming pod can only be scheduled
+ to zone3 to become 1/1/1; scheduling it onto zone1(zone2)
+ would make the ActualSkew(2-0) on zone1(zone2) violate
+ MaxSkew(1). - if MaxSkew is 2, incoming pod can be
+ scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`,
+ it is used to give higher precedence to topologies
+ that satisfy it. It''s a required field. Default value
+ is 1 and 0 is not allowed.'
format: int32
type: integer
topologyKey:
- description: TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. It's a required field.
+ description: TopologyKey is the key of node labels.
+ Nodes that have a label with this key and identical
+ values are considered to be in the same topology.
+ We consider each <key, value> as a "bucket", and try
+ to put balanced number of pods into each bucket. It's
+ a required field.
type: string
whenUnsatisfiable:
- description: 'WhenUnsatisfiable indicates how to deal with a pod if it doesn''t satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won''t make it *more* imbalanced. It''s a required field.'
+ description: 'WhenUnsatisfiable indicates how to deal
+ with a pod if it doesn''t satisfy the spread constraint.
+ - DoNotSchedule (default) tells the scheduler not
+ to schedule it. - ScheduleAnyway tells the scheduler
+ to schedule the pod in any location, but giving
+ higher precedence to topologies that would help reduce
+ the skew. A constraint is considered "Unsatisfiable"
+ for an incoming pod if and only if every possible
+ node assigment for that pod would violate "MaxSkew"
+ on some topology. For example, in a 3-zone cluster,
+ MaxSkew is set to 1, and pods with the same labelSelector
+ spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P
+ | P | P | If WhenUnsatisfiable is set to DoNotSchedule,
+ incoming pod can only be scheduled to zone2(zone3)
+ to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3)
+ satisfies MaxSkew(1). In other words, the cluster
+ can still be imbalanced, but scheduler won''t make
+ it *more* imbalanced. It''s a required field.'
type: string
required:
- maxSkew
@@ -2618,30 +4129,49 @@
- whenUnsatisfiable
x-kubernetes-list-type: map
volumes:
- description: Additional non-data volumes to load into the default container.
+ description: Additional non-data volumes to load into the
+ default container.
items:
- description: AdditionalVolume provides information on additional volumes that should be loaded into pods
+ description: AdditionalVolume provides information on additional
+ volumes that should be loaded into pods
properties:
defaultContainerMount:
- description: DefaultContainerMount defines how to mount this volume into the default container. If this volume is to be used only with sidecar or non-default init containers, then this option is not necessary.
+ description: DefaultContainerMount defines how to mount
+ this volume into the default container. If this volume
+ is to be used only with sidecar or non-default init
+ containers, then this option is not necessary.
properties:
mountPath:
- description: Path within the container at which the volume should be mounted. Must not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: 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.
+ description: 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.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which the
+ container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: 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.
+ description: 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.
type: string
required:
- mountPath
@@ -2651,60 +4181,100 @@
description: Name of the volume
type: string
source:
- description: Source is the source of the Volume to be loaded into the solrCloud Pod
+ description: Source is the source of the Volume to be
+ loaded into the solrCloud Pod
properties:
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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 TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume
+ that you want to mount. Tip: Ensure that the
+ filesystem 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
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: '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).'
+ description: '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).'
format: int32
type: integer
readOnly:
- description: 'Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'Specify "true" to force and set
+ the ReadOnly property in VolumeMounts to "true".
+ If omitted, the default is "false". More info:
+ https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: boolean
volumeID:
- description: 'Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'Unique ID of the persistent disk
+ resource in AWS (Amazon EBS volume). More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: string
required:
- volumeID
type: object
azureDisk:
- description: AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+ description: AzureDisk represents an Azure Data
+ Disk mount on the host and bind mount to the pod.
properties:
cachingMode:
- description: 'Host Caching mode: None, Read Only, Read Write.'
+ description: 'Host Caching mode: None, Read
+ Only, Read Write.'
type: string
diskName:
- description: The Name of the data disk in the blob storage
+ description: The Name of the data disk in the
+ blob storage
type: string
diskURI:
- description: The URI the data disk in the blob storage
+ description: The URI the data disk in the blob
+ storage
type: string
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
kind:
- description: 'Expected values 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'
+ description: 'Expected values 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'
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
required:
- diskName
- diskURI
type: object
azureFile:
- description: AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
+ description: AzureFile represents an Azure File
+ Service mount on the host and bind mount to the
+ pod.
properties:
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretName:
- description: the name of secret that contains Azure Storage Account Name and Key
+ description: the name of secret that contains
+ Azure Storage Account Name and Key
type: string
shareName:
description: Share Name
@@ -2714,78 +4284,142 @@
- shareName
type: object
cephfs:
- description: CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
+ description: CephFS represents a Ceph FS mount on
+ the host that shares a pod's lifetime
properties:
monitors:
- description: 'Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'Required: Monitors is a collection
+ of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
items:
type: string
type: array
path:
- description: 'Optional: Used as the mounted root, rather than the full Ceph tree, default is /'
+ description: 'Optional: Used as the mounted
+ root, rather than the full Ceph tree, default
+ is /'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
secretFile:
- description: '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'
+ description: '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'
type: string
secretRef:
- description: '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'
+ description: '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'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
user:
- description: 'Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'Optional: User is the rados user
+ name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
required:
- monitors
type: object
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'
+ description: 'Cinder represents a cinder volume
+ attached and mounted on kubelets host machine.
+ More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
properties:
fsType:
- description: 'Filesystem type to mount. Must be a filesystem 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'
+ description: 'Filesystem type to mount. Must
+ be a filesystem 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'
type: string
readOnly:
- description: 'Optional: 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'
+ description: 'Optional: 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'
type: boolean
secretRef:
- description: 'Optional: points to a secret object containing parameters used to connect to OpenStack.'
+ description: 'Optional: points to a secret object
+ containing parameters used to connect to OpenStack.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
volumeID:
- description: 'volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'volume id used to identify the
+ volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
required:
- volumeID
type: object
configMap:
- description: ConfigMap represents a configMap that should populate this volume
+ description: ConfigMap represents a configMap that
+ should populate this volume
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: 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 '..'.
+ description: 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 '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to a path within
+ a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -2793,85 +4427,156 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its keys must be defined
+ description: Specify whether the ConfigMap or
+ its keys must be defined
type: boolean
type: object
csi:
- description: CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
+ description: CSI (Container Storage Interface) represents
+ ephemeral storage that is handled by certain external
+ CSI drivers (Beta feature).
properties:
driver:
- description: Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
+ description: Driver is the name of the CSI driver
+ that handles this volume. Consult with your
+ admin for the correct name as registered in
+ the cluster.
type: string
fsType:
- description: Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
+ description: Filesystem type to mount. Ex. "ext4",
+ "xfs", "ntfs". If not provided, the empty
+ value is passed to the associated CSI driver
+ which will determine the default filesystem
+ to apply.
type: string
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.
+ 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.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
readOnly:
- description: Specifies a read-only configuration for the volume. Defaults to false (read/write).
+ description: Specifies a read-only configuration
+ for the volume. Defaults to false (read/write).
type: boolean
volumeAttributes:
additionalProperties:
type: string
- description: VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
+ description: VolumeAttributes stores driver-specific
+ properties that are passed to the CSI driver.
+ Consult your driver's documentation for supported
+ values.
type: object
required:
- driver
type: object
downwardAPI:
- description: DownwardAPI represents downward API about the pod that should populate this volume
+ description: DownwardAPI represents downward API
+ about the pod that should populate this volume
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: Items is a list of downward API volume file
+ description: Items is a list of downward API
+ volume file
items:
- description: DownwardAPIVolumeFile represents information to create the file containing the pod field
+ description: DownwardAPIVolumeFile represents
+ information to create the file containing
+ the pod field
properties:
fieldRef:
- description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
+ description: 'Required: Selects a field
+ of the pod: only annotations, labels,
+ name and namespace are supported.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema
+ the FieldPath is written in terms
+ of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to
+ select in the specified API version.
type: string
required:
- fieldPath
type: object
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative path name 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 ''..'''
+ description: 'Required: Path is the relative
+ path name 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 ''..'''
type: string
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.'
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ requests.cpu and requests.memory) are
+ currently supported.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required
+ for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output
+ format of the exposed resources,
+ defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
- description: 'Required: resource to select'
+ description: 'Required: resource to
+ select'
type: string
required:
- resource
@@ -2882,57 +4587,147 @@
type: array
type: object
emptyDir:
- description: 'EmptyDir represents a temporary directory that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
+ description: 'EmptyDir represents a temporary directory
+ that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
properties:
medium:
- description: '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'
+ description: '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'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
+ description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: "Ephemeral represents a volume that is handled by a cluster storage driver (Alpha feature). 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."
+ description: "Ephemeral represents a volume that
+ is handled by a cluster storage driver (Alpha
+ feature). 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."
properties:
readOnly:
- description: Specifies a read-only configuration for the volume. Defaults to false (read/write).
+ description: Specifies a read-only configuration
+ for the volume. Defaults to false (read/write).
type: boolean
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). \n 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. \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."
+ 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).
+ \n 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. \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."
properties:
metadata:
- description: 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.
+ description: 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.
type: object
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.
+ 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.
properties:
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'
+ description: 'AccessModes contains the
+ desired access modes the volume should
+ have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. 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.'
+ description: 'This field can be used
+ to specify either: * An existing VolumeSnapshot
+ object (snapshot.storage.k8s.io/VolumeSnapshot)
+ * An existing PVC (PersistentVolumeClaim)
+ * An existing custom resource that
+ implements data population (Alpha)
+ In order to use custom resource types
+ that implement data population, the
+ AnyVolumeDataSource feature gate must
+ be enabled. 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.'
properties:
apiGroup:
- description: 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.
+ description: 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.
type: string
kind:
- description: Kind is the type of resource being referenced
+ description: Kind is the type of
+ resource being referenced
type: string
name:
- description: Name is the name of resource being referenced
+ description: Name is the name of
+ resource being referenced
type: string
required:
- kind
- name
type: object
resources:
- description: 'Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'Resources represents the
+ minimum resources the volume should
+ have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
@@ -2941,7 +4736,9 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the
+ maximum amount of compute resources
+ allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -2950,25 +4747,54 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
selector:
- description: A label query over volumes to consider for binding.
+ description: A label query over volumes
+ to consider for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is
+ a list of label selector requirements.
+ The requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector
+ requirement is a selector that
+ contains values, a key, and
+ an operator that relates the
+ key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to
+ a set of values. Valid operators
+ are In, NotIn, Exists and
+ DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -2980,17 +4806,32 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
storageClassName:
- description: 'Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'Name of the StorageClass
+ required by the claim. More info:
+ https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
+ description: volumeMode defines what
+ type of volume is required by the
+ claim. Value of Filesystem is implied
+ when not included in claim spec.
type: string
volumeName:
- description: VolumeName is the binding reference to the PersistentVolume backing this claim.
+ description: VolumeName is the binding
+ reference to the PersistentVolume
+ backing this claim.
type: string
type: object
required:
@@ -2998,90 +4839,157 @@
type: object
type: object
fc:
- description: FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
+ description: FC represents a Fibre Channel resource
+ that is attached to a kubelet's host machine and
+ then exposed to the pod.
properties:
fsType:
- description: 'Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
lun:
description: 'Optional: FC target lun number'
format: int32
type: integer
readOnly:
- description: 'Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'Optional: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.'
type: boolean
targetWWNs:
- description: 'Optional: FC target worldwide names (WWNs)'
+ description: 'Optional: FC target worldwide
+ names (WWNs)'
items:
type: string
type: array
wwids:
- description: 'Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.'
+ description: 'Optional: FC volume world wide
+ identifiers (wwids) Either wwids or combination
+ of targetWWNs and lun must be set, but not
+ both simultaneously.'
items:
type: string
type: array
type: object
flexVolume:
- description: FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
+ description: FlexVolume represents a generic volume
+ resource that is provisioned/attached using an
+ exec based plugin.
properties:
driver:
- description: Driver is the name of the driver to use for this volume.
+ description: Driver is the name of the driver
+ to use for this volume.
type: string
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ The default filesystem depends on FlexVolume
+ script.
type: string
options:
additionalProperties:
type: string
- description: 'Optional: Extra command options if any.'
+ description: 'Optional: Extra command options
+ if any.'
type: object
readOnly:
- description: 'Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'Optional: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.'
type: boolean
secretRef:
- description: '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.'
+ description: '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.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
required:
- driver
type: object
flocker:
- description: Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
+ description: Flocker represents a Flocker volume
+ attached to a kubelet's host machine. This depends
+ on the Flocker control service being running
properties:
datasetName:
- description: Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
+ description: Name of the dataset stored as metadata
+ -> name on the dataset for Flocker should
+ be considered as deprecated
type: string
datasetUUID:
- description: UUID of the dataset. This is unique identifier of a Flocker dataset
+ description: UUID of the dataset. This is unique
+ identifier of a Flocker dataset
type: string
type: object
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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 TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume
+ that you want to mount. Tip: Ensure that the
+ filesystem 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
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: '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). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: '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). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
format: int32
type: integer
pdName:
- description: 'Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'Unique name of the PD resource
+ in GCE. Used to identify the disk in GCE.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: string
readOnly:
- description: 'ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'ReadOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: boolean
required:
- pdName
type: object
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.'
+ 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.'
properties:
directory:
- description: 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.
+ description: 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.
type: string
repository:
description: Repository URL
@@ -3093,75 +5001,121 @@
- repository
type: object
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'
+ 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'
properties:
endpoints:
- description: 'EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'EndpointsName is the endpoint
+ name that details Glusterfs topology. More
+ info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
path:
- description: 'Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'Path is the Glusterfs volume path.
+ More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
required:
- endpoints
- path
type: object
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.'
+ 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.'
properties:
path:
- description: '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'
+ description: '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'
type: string
type:
- description: 'Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
+ description: 'Type for HostPath Volume Defaults
+ to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
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'
+ 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'
properties:
chapAuthDiscovery:
- description: whether support iSCSI Discovery CHAP authentication
+ description: whether support iSCSI Discovery
+ CHAP authentication
type: boolean
chapAuthSession:
- description: whether support iSCSI Session CHAP authentication
+ description: whether support iSCSI Session CHAP
+ authentication
type: boolean
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume
+ that you want to mount. Tip: Ensure that the
+ filesystem 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#iscsi
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
initiatorName:
- description: Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
+ description: Custom iSCSI Initiator Name. If
+ initiatorName is specified with iscsiInterface
+ simultaneously, new iSCSI interface <target
+ portal>:<volume name> will be created for
+ the connection.
type: string
iqn:
description: Target iSCSI Qualified Name.
type: string
iscsiInterface:
- description: iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
+ description: iSCSI Interface Name that uses
+ an iSCSI transport. Defaults to 'default'
+ (tcp).
type: string
lun:
description: iSCSI Target Lun number.
format: int32
type: integer
portals:
- description: 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).
+ description: 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).
items:
type: string
type: array
readOnly:
- description: ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
+ description: ReadOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
type: boolean
secretRef:
- description: CHAP Secret for iSCSI target and initiator authentication
+ description: CHAP Secret for iSCSI target and
+ initiator authentication
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
targetPortal:
- description: 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).
+ description: 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).
type: string
required:
- iqn
@@ -3169,89 +5123,160 @@
- targetPortal
type: object
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'
+ 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'
properties:
path:
- description: 'Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'Path that is exported by the NFS
+ server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
server:
- description: 'Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'Server is the hostname or IP address
+ of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- path
- server
type: object
persistentVolumeClaim:
- description: 'PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'PersistentVolumeClaimVolumeSource
+ represents a reference to a PersistentVolumeClaim
+ in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
claimName:
- description: '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'
+ description: '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'
type: string
readOnly:
- description: Will force the ReadOnly setting in VolumeMounts. Default false.
+ description: Will force the ReadOnly setting
+ in VolumeMounts. Default false.
type: boolean
required:
- claimName
type: object
photonPersistentDisk:
- description: PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
+ description: PhotonPersistentDisk represents a PhotonController
+ persistent disk attached and mounted on kubelets
+ host machine
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
pdID:
- description: ID that identifies Photon Controller persistent disk
+ description: ID that identifies Photon Controller
+ persistent disk
type: string
required:
- pdID
type: object
portworxVolume:
- description: PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
+ description: PortworxVolume represents a portworx
+ volume attached and mounted on kubelets host machine
properties:
fsType:
- description: FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
+ description: FSType represents the filesystem
+ type to mount Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs". Implicitly inferred to be "ext4" if
+ unspecified.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
volumeID:
- description: VolumeID uniquely identifies a Portworx volume
+ description: VolumeID uniquely identifies a
+ Portworx volume
type: string
required:
- volumeID
type: object
projected:
- description: Items for all in one resources secrets, configmaps, and downward API
+ description: Items for all in one resources secrets,
+ configmaps, and downward API
properties:
defaultMode:
- description: 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.
+ description: 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.
format: int32
type: integer
sources:
description: list of volume projections
items:
- description: Projection that may be projected along with other supported volume types
+ description: Projection that may be projected
+ along with other supported volume types
properties:
configMap:
- description: information about the configMap data to project
+ description: information about the configMap
+ data to project
properties:
items:
- description: 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 '..'.
+ description: 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
+ '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to
+ a path within a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -3259,54 +5284,102 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent.
+ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its keys must be defined
+ description: Specify whether the ConfigMap
+ or its keys must be defined
type: boolean
type: object
downwardAPI:
- description: information about the downwardAPI data to project
+ description: information about the downwardAPI
+ data to project
properties:
items:
- description: Items is a list of DownwardAPIVolume file
+ description: Items is a list of DownwardAPIVolume
+ file
items:
- description: DownwardAPIVolumeFile represents information to create the file containing the pod field
+ description: DownwardAPIVolumeFile
+ represents information to create
+ the file containing the pod field
properties:
fieldRef:
- description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
+ description: 'Required: Selects
+ a field of the pod: only annotations,
+ labels, name and namespace
+ are supported.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of
+ the schema the FieldPath
+ is written in terms of,
+ defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the
+ field to select in the
+ specified API version.
type: string
required:
- fieldPath
type: object
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative path name 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 ''..'''
+ description: 'Required: Path
+ is the relative path name
+ 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 ''..'''
type: string
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.'
+ description: 'Selects a resource
+ of the container: only resources
+ limits and requests (limits.cpu,
+ limits.memory, requests.cpu
+ and requests.memory) are currently
+ supported.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container
+ name: required for volumes,
+ optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the
+ output format of the exposed
+ resources, defaults to
+ "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
- description: 'Required: resource to select'
+ description: 'Required:
+ resource to select'
type: string
required:
- resource
@@ -3317,22 +5390,57 @@
type: array
type: object
secret:
- description: information about the secret data to project
+ description: information about the secret
+ data to project
properties:
items:
- description: 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 '..'.
+ description: 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
+ '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to
+ a path within a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -3340,24 +5448,49 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent.
+ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret
+ or its key must be defined
type: boolean
type: object
serviceAccountToken:
- description: information about the serviceAccountToken data to project
+ description: information about the serviceAccountToken
+ data to project
properties:
audience:
- description: 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.
+ description: 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.
type: string
expirationSeconds:
- description: 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.
+ description: 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.
format: int64
type: integer
path:
- description: Path is the path relative to the mount point of the file to project the token into.
+ description: Path is the path relative
+ to the mount point of the file to
+ project the token into.
type: string
required:
- path
@@ -3366,103 +5499,159 @@
type: array
type: object
quobyte:
- description: Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
+ description: Quobyte represents a Quobyte mount
+ on the host that shares a pod's lifetime
properties:
group:
- description: Group to map volume access to Default is no group
+ description: Group to map volume access to Default
+ is no group
type: string
readOnly:
- description: ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
+ description: ReadOnly here will force the Quobyte
+ volume to be mounted with read-only permissions.
+ Defaults to false.
type: boolean
registry:
- description: 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
+ description: 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
type: string
tenant:
- description: Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ description: Tenant owning the given Quobyte
+ volume in the Backend Used with dynamically
+ provisioned Quobyte volumes, value is set
+ by the plugin
type: string
user:
- description: User to map volume access to Defaults to serivceaccount user
+ description: User to map volume access to Defaults
+ to serivceaccount user
type: string
volume:
- description: Volume is a string that references an already created Quobyte volume by name.
+ description: Volume is a string that references
+ an already created Quobyte volume by name.
type: string
required:
- registry
- volume
type: object
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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#rbd TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume
+ that you want to mount. Tip: Ensure that the
+ filesystem 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#rbd
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
image:
- description: 'The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'The rados image name. More info:
+ https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
keyring:
- description: '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'
+ description: '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'
type: string
monitors:
- description: 'A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'A collection of Ceph monitors.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
items:
type: string
type: array
pool:
- description: 'The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'The rados pool name. Default is
+ rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
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'
+ 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'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
user:
- description: 'The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'The rados user name. Default is
+ admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- image
- monitors
type: object
scaleIO:
- description: ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
+ description: ScaleIO represents a ScaleIO persistent
+ volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Default is "xfs".
type: string
gateway:
- description: The host address of the ScaleIO API Gateway.
+ description: The host address of the ScaleIO
+ API Gateway.
type: string
protectionDomain:
- description: The name of the ScaleIO Protection Domain for the configured storage.
+ description: The name of the ScaleIO Protection
+ Domain for the configured storage.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
+ description: SecretRef references to the secret
+ for ScaleIO user and other sensitive information.
+ If this is not provided, Login operation will
+ fail.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
sslEnabled:
- description: Flag to enable/disable SSL communication with Gateway, default false
+ description: Flag to enable/disable SSL communication
+ with Gateway, default false
type: boolean
storageMode:
- description: Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
+ description: Indicates whether the storage for
+ a volume should be ThickProvisioned or ThinProvisioned.
+ Default is ThinProvisioned.
type: string
storagePool:
- description: The ScaleIO Storage Pool associated with the protection domain.
+ description: The ScaleIO Storage Pool associated
+ with the protection domain.
type: string
system:
- description: The name of the storage system as configured in ScaleIO.
+ description: The name of the storage system
+ as configured in ScaleIO.
type: string
volumeName:
- description: The name of a volume already created in the ScaleIO system that is associated with this volume source.
+ description: The name of a volume already created
+ in the ScaleIO system that is associated with
+ this volume source.
type: string
required:
- gateway
@@ -3470,26 +5659,63 @@
- system
type: object
secret:
- description: 'Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'Secret represents a secret that should
+ populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: 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 '..'.
+ description: 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 '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to a path within
+ a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -3497,49 +5723,80 @@
type: object
type: array
optional:
- description: Specify whether the Secret or its keys must be defined
+ description: Specify whether the Secret or its
+ keys must be defined
type: boolean
secretName:
- description: 'Name of the secret in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'Name of the secret in the pod''s
+ namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
type: string
type: object
storageos:
- description: StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
+ description: StorageOS represents a StorageOS volume
+ attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
+ description: SecretRef specifies the secret
+ to use for obtaining the StorageOS API credentials. If
+ not specified, default values will be attempted.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
volumeName:
- description: VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
+ description: VolumeName is the human-readable
+ name of the StorageOS volume. Volume names
+ are only unique within a namespace.
type: string
volumeNamespace:
- description: 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 do not pre-exist within StorageOS will be created.
+ description: 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 do not pre-exist
+ within StorageOS will be created.
type: string
type: object
vsphereVolume:
- description: VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
+ description: VsphereVolume represents a vSphere
+ volume attached and mounted on kubelets host machine
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
storagePolicyID:
- description: Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
+ description: Storage Policy Based Management
+ (SPBM) profile ID associated with the StoragePolicyName.
type: string
storagePolicyName:
- description: Storage Policy Based Management (SPBM) profile name.
+ description: Storage Policy Based Management
+ (SPBM) profile name.
type: string
volumePath:
- description: Path that identifies vSphere volume vmdk
+ description: Path that identifies vSphere volume
+ vmdk
type: string
required:
- volumePath
@@ -3552,7 +5809,8 @@
type: array
type: object
serviceOptions:
- description: ServiceOptions defines the custom options for the solrPrometheusExporter Service.
+ description: ServiceOptions defines the custom options for the
+ solrPrometheusExporter Service.
properties:
annotations:
additionalProperties:
@@ -3567,7 +5825,8 @@
type: object
type: object
exporterEntrypoint:
- description: The entrypoint into the exporter. Defaults to the official docker-solr location.
+ description: The entrypoint into the exporter. Defaults to the official
+ docker-solr location.
type: string
image:
description: Image of Solr Prometheus Exporter to run.
@@ -3575,7 +5834,8 @@
imagePullSecret:
type: string
pullPolicy:
- description: PullPolicy describes a policy for if/when to pull a container image
+ description: PullPolicy describes a policy for if/when to pull
+ a container image
type: string
repository:
type: string
@@ -3586,45 +5846,67 @@
description: The xml config for the metrics
type: string
numThreads:
- description: Number of threads to use for the prometheus exporter Defaults to 1
+ description: Number of threads to use for the prometheus exporter
+ Defaults to 1
format: int32
type: integer
restartSchedule:
- description: "Perform a scheduled restart on the given schedule, in CRON format. \n Multiple CRON syntaxes are supported - Standard CRON (e.g. \"CRON_TZ=Asia/Seoul 0 6 * * ?\") - Predefined Schedules (e.g. \"@yearly\", \"@weekly\", etc.) - Intervals (e.g. \"@every 10h30m\") \n For more information please check this reference: https://pkg.go.dev/github.com/robfig/cron/v3?utm_source=godoc#hdr-CRON_Expression_Format"
+ description: "Perform a scheduled restart on the given schedule, in
+ CRON format. \n Multiple CRON syntaxes are supported - Standard
+ CRON (e.g. \"CRON_TZ=Asia/Seoul 0 6 * * ?\") - Predefined Schedules
+ (e.g. \"@yearly\", \"@weekly\", etc.) - Intervals (e.g. \"@every
+ 10h30m\") \n For more information please check this reference: https://pkg.go.dev/github.com/robfig/cron/v3?utm_source=godoc#hdr-CRON_Expression_Format"
type: string
scrapeInterval:
- description: The interval to scrape Solr at (in seconds) Defaults to 60 seconds
+ description: The interval to scrape Solr at (in seconds) Defaults
+ to 60 seconds
format: int32
type: integer
solrReference:
description: Reference of the Solr instance to collect metrics for
properties:
basicAuthSecret:
- description: 'If Solr is secured, you''ll need to provide credentials for the Prometheus exporter to authenticate via a kubernetes.io/basic-auth secret which must contain a username and password. If basic auth is enabled on the SolrCloud instance, the default secret (unless you are supplying your own) is named using the pattern: <SOLR_CLOUD_NAME>-solrcloud-basic-auth. If using the security.json bootstrapped by the Solr operator, then the username is "k8s-oper".'
+ description: 'If Solr is secured, you''ll need to provide credentials
+ for the Prometheus exporter to authenticate via a kubernetes.io/basic-auth
+ secret which must contain a username and password. If basic
+ auth is enabled on the SolrCloud instance, the default secret
+ (unless you are supplying your own) is named using the pattern:
+ <SOLR_CLOUD_NAME>-solrcloud-basic-auth. If using the security.json
+ bootstrapped by the Solr operator, then the username is "k8s-oper".'
type: string
cloud:
description: Reference of a solrCloud instance
properties:
name:
- description: The name of a solr cloud running within the kubernetes cluster
+ description: The name of a solr cloud running within the kubernetes
+ cluster
type: string
namespace:
- description: The namespace of a solr cloud running within the kubernetes cluster
+ description: The namespace of a solr cloud running within
+ the kubernetes cluster
type: string
zkConnectionInfo:
- description: The ZK Connection information for a cloud, could be used for solr's running outside of the kube cluster
+ description: The ZK Connection information for a cloud, could
+ be used for solr's running outside of the kube cluster
properties:
acl:
- description: ZooKeeper ACL to use when connecting with ZK. This ACL should have ALL permission in the given chRoot.
+ description: ZooKeeper ACL to use when connecting with
+ ZK. This ACL should have ALL permission in the given
+ chRoot.
properties:
passwordKey:
- description: The name of the key in the given secret that contains the ACL password
+ description: The name of the key in the given secret
+ that contains the ACL password
type: string
secret:
- description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
+ description: The name of the Kubernetes Secret that
+ stores the username and password for the ACL. This
+ secret must be in the same namespace as the solrCloud
+ or prometheusExporter is running in.
type: string
usernameKey:
- description: The name of the key in the given secret that contains the ACL username
+ description: The name of the key in the given secret
+ that contains the ACL username
type: string
required:
- passwordKey
@@ -3635,22 +5917,33 @@
description: The ChRoot to connect solr at
type: string
externalConnectionString:
- description: The connection string to connect to the ensemble from outside of the Kubernetes cluster If external and no internal connection string is provided, the external cnx string will be used as the internal cnx string
+ description: The connection string to connect to the ensemble
+ from outside of the Kubernetes cluster If external and
+ no internal connection string is provided, the external
+ cnx string will be used as the internal cnx string
type: string
internalConnectionString:
- description: The connection string to connect to the ensemble from within the Kubernetes cluster
+ description: The connection string to connect to the ensemble
+ from within the Kubernetes cluster
type: string
readOnlyAcl:
- description: ZooKeeper ACL to use when connecting with ZK for reading operations. This ACL should have READ permission in the given chRoot.
+ description: ZooKeeper ACL to use when connecting with
+ ZK for reading operations. This ACL should have READ
+ permission in the given chRoot.
properties:
passwordKey:
- description: The name of the key in the given secret that contains the ACL password
+ description: The name of the key in the given secret
+ that contains the ACL password
type: string
secret:
- description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
+ description: The name of the Kubernetes Secret that
+ stores the username and password for the ACL. This
+ secret must be in the same namespace as the solrCloud
+ or prometheusExporter is running in.
type: string
usernameKey:
- description: The name of the key in the given secret that contains the ACL username
+ description: The name of the key in the given secret
+ that contains the ACL username
type: string
required:
- passwordKey
@@ -3660,105 +5953,151 @@
type: object
type: object
solrTLS:
- description: Settings to configure the SolrJ client used to request metrics from TLS enabled Solr pods
+ description: Settings to configure the SolrJ client used to request
+ metrics from TLS enabled Solr pods
properties:
checkPeerName:
- description: TLS certificates contain host/ip "peer name" information that is validated by default.
+ description: TLS certificates contain host/ip "peer name"
+ information that is validated by default.
type: boolean
clientAuth:
default: None
- description: Determines the client authentication method, either None, Want, or Need; this affects K8s ability to call liveness / readiness probes so use cautiously. Only applies for server certificates, has no effect on client certificates
+ description: Determines the client authentication method,
+ either None, Want, or Need; this affects K8s ability to
+ call liveness / readiness probes so use cautiously. Only
+ applies for server certificates, has no effect on client
+ certificates
enum:
- None
- Want
- Need
type: string
keyStorePasswordSecret:
- description: Secret containing the key store password; this field is required unless mountedTLSDir is used, as most JVMs do not support pkcs12 keystores without a password
+ description: Secret containing the key store password; this
+ field is required unless mountedTLSDir is used, as most
+ JVMs do not support pkcs12 keystores without a password
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must
+ be defined
type: boolean
required:
- key
type: object
mountedTLSDir:
- description: Used to specify a path where the keystore, truststore, and password files for the TLS certificate are mounted by an external agent or CSI driver. This option is typically used with `spec.updateStrategy.restartSchedule` to restart Solr pods before the mounted TLS cert expires.
+ description: Used to specify a path where the keystore, truststore,
+ and password files for the TLS certificate are mounted by
+ an external agent or CSI driver. This option is typically
+ used with `spec.updateStrategy.restartSchedule` to restart
+ Solr pods before the mounted TLS cert expires.
properties:
keystoreFile:
- description: Override the name of the keystore file; no default, if you don't supply this setting, then the corresponding env vars and Java system properties will not be configured for the pod template
+ description: Override the name of the keystore file; no
+ default, if you don't supply this setting, then the
+ corresponding env vars and Java system properties will
+ not be configured for the pod template
type: string
keystorePasswordFile:
- description: Override the name of the keystore password file; defaults to keystore-password
+ description: Override the name of the keystore password
+ file; defaults to keystore-password
type: string
path:
- description: The path on the main Solr container where the TLS files are mounted by some external agent or CSI Driver
+ description: The path on the main Solr container where
+ the TLS files are mounted by some external agent or
+ CSI Driver
type: string
truststoreFile:
- description: Override the name of the truststore file; no default, if you don't supply this setting, then the corresponding env vars and Java system properties will not be configured for the pod template
+ description: Override the name of the truststore file;
+ no default, if you don't supply this setting, then the
+ corresponding env vars and Java system properties will
+ not be configured for the pod template
type: string
truststorePasswordFile:
- description: Override the name of the truststore password file; defaults to the same value as the KeystorePasswordFile
+ description: Override the name of the truststore password
+ file; defaults to the same value as the KeystorePasswordFile
type: string
required:
- path
type: object
pkcs12Secret:
- description: TLS Secret containing a pkcs12 keystore; required for Solr pods unless mountedTLSDir is used
+ description: TLS Secret containing a pkcs12 keystore; required
+ for Solr pods unless mountedTLSDir is used
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must
+ be defined
type: boolean
required:
- key
type: object
restartOnTLSSecretUpdate:
- description: Opt-in flag to restart Solr pods after TLS secret updates, such as if the cert is renewed; default is false. This option only applies when using the `spec.solrTLS.pkcs12Secret` option; when using the `spec.solrTLS.mountedTLSDir` option, you need to ensure pods get restarted before the certs expire, see `spec.updateStrategy.restartSchedule` for scheduling restarts.
+ description: Opt-in flag to restart Solr pods after TLS secret
+ updates, such as if the cert is renewed; default is false.
+ This option only applies when using the `spec.solrTLS.pkcs12Secret`
+ option; when using the `spec.solrTLS.mountedTLSDir` option,
+ you need to ensure pods get restarted before the certs expire,
+ see `spec.updateStrategy.restartSchedule` for scheduling
+ restarts.
type: boolean
trustStorePasswordSecret:
- description: Secret containing the trust store password; if not provided the keyStorePassword will be used
+ description: Secret containing the trust store password; if
+ not provided the keyStorePassword will be used
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must
+ be defined
type: boolean
required:
- key
type: object
trustStoreSecret:
- description: TLS Secret containing a pkcs12 truststore; if not provided, then the keystore and password are used for the truststore The specified key is used as the truststore file name when mounted into Solr pods
+ description: TLS Secret containing a pkcs12 truststore; if
+ not provided, then the keystore and password are used for
+ the truststore The specified key is used as the truststore
+ file name when mounted into Solr pods
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must
+ be defined
type: boolean
required:
- key
type: object
verifyClientHostname:
- description: Verify client's hostname during SSL handshake Only applies for server configuration
+ description: Verify client's hostname during SSL handshake
+ Only applies for server configuration
type: boolean
type: object
standalone:
@@ -3775,7 +6114,8 @@
- solrReference
type: object
status:
- description: SolrPrometheusExporterStatus defines the observed state of SolrPrometheusExporter
+ description: SolrPrometheusExporterStatus defines the observed state of
+ SolrPrometheusExporter
properties:
ready:
description: Is the prometheus exporter up and running
diff --git a/controllers/util/solr_update_util.go b/controllers/util/solr_update_util.go
index ab91dba..422bf20 100644
--- a/controllers/util/solr_update_util.go
+++ b/controllers/util/solr_update_util.go
@@ -93,8 +93,8 @@
// If an out of date pod has a solr container that is not started, it should be accounted for in outOfDatePodsNotStartedCount not outOfDatePods.
//
// TODO:
-// - Think about caching this for ~250 ms? Not a huge need to send these requests milliseconds apart.
-// - Might be too much complexity for very little gain.
+// - Think about caching this for ~250 ms? Not a huge need to send these requests milliseconds apart.
+// - Might be too much complexity for very little gain.
func DeterminePodsSafeToUpdate(ctx context.Context, cloud *solr.SolrCloud, outOfDatePods []corev1.Pod, readyPods int, availableUpdatedPodCount int, outOfDatePodsNotStartedCount int, logger logr.Logger) (podsToUpdate []corev1.Pod, podsHaveReplicas map[string]bool, retryLater bool) {
// Before fetching the cluster state, be sure that there is room to update at least 1 pod
maxPodsUnavailable, unavailableUpdatedPodCount, maxPodsToUpdate := calculateMaxPodsToUpdate(cloud, len(outOfDatePods), outOfDatePodsNotStartedCount, availableUpdatedPodCount)
@@ -336,9 +336,10 @@
/*
findSolrNodeContents will take a cluster and overseerLeader response from the SolrCloud Collections API, and aggregate the information.
This aggregated info is returned as:
- - A map from Solr nodeName to SolrNodeContents, with the information from the clusterState and overseerLeader
- - A map from unique shard name (collection+shard) to the count of replicas that are not active for that shard.
- - If a node is not live, then all shards that live on that node will be considered "not active"
+ - A map from Solr nodeName to SolrNodeContents, with the information from the clusterState and overseerLeader
+ - A map from unique shard name (collection+shard) to the count of replicas for that shard.
+ - A map from unique shard name (collection+shard) to the count of replicas that are not active for that shard.
+ - If a node is not live, then all shards that live on that node will be considered "not active"
*/
func findSolrNodeContents(cluster solr_api.SolrClusterStatus, overseerLeader string, managedSolrNodeNames map[string]bool) (nodeContents map[string]*SolrNodeContents, totalShardReplicas map[string]int, shardReplicasNotActive map[string]int, allManagedPodsLive bool) {
nodeContents = make(map[string]*SolrNodeContents, 0)
diff --git a/controllers/zk_api/groupversion_info.go b/controllers/zk_api/groupversion_info.go
index 231bc12..71e0ce8 100644
--- a/controllers/zk_api/groupversion_info.go
+++ b/controllers/zk_api/groupversion_info.go
@@ -16,8 +16,8 @@
*/
// Package v1beta1 contains API Schema definitions for the zookeeper.pravega.io v1beta1 API group
-//+kubebuilder:object:generate=true
-//+groupName=zookeeper.pravega.io
+// +kubebuilder:object:generate=true
+// +groupName=zookeeper.pravega.io
package zk_api
import (
diff --git a/go.mod b/go.mod
index ccd52b9..12eb8b0 100644
--- a/go.mod
+++ b/go.mod
@@ -1,6 +1,6 @@
module github.com/apache/solr-operator
-go 1.17
+go 1.19
require (
github.com/fsnotify/fsnotify v1.4.9
diff --git a/go.sum b/go.sum
index 048268d..0b0b5ea 100644
--- a/go.sum
+++ b/go.sum
@@ -63,7 +63,6 @@
github.com/bketelsen/crypt v0.0.3-0.20200106085610-5cbc8cc4026c/go.mod h1:MKsuJmJgSg28kpZDP6UIiPt0e0Oz0kqKNGyRaWEPv84=
github.com/blang/semver v3.5.1+incompatible/go.mod h1:kRBLl5iJ+tD4TcOOxsy/0fnwebNt5EWlYSAyrTnjyyk=
github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
-github.com/cespare/xxhash v1.1.0 h1:a6HrQnmkObjyL+Gs60czilIUGqrzKutQD6XZog3p+ko=
github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc=
github.com/cespare/xxhash/v2 v2.1.1 h1:6MnRN8NT7+YBpUIWxHtefFZOKTAPgGjpQSxqLNn0+qY=
github.com/cespare/xxhash/v2 v2.1.1/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
diff --git a/hack/release/wizard/releaseWizard.yaml b/hack/release/wizard/releaseWizard.yaml
index d7b9bb8..6ea0cbb 100644
--- a/hack/release/wizard/releaseWizard.yaml
+++ b/hack/release/wizard/releaseWizard.yaml
@@ -223,7 +223,7 @@
You will need these tools:
* Python v3.4 or later, with dependencies listed in requirements.txt
- * Go 1.17
+ * Go 1.19
* gpg
* git
* svn
@@ -903,7 +903,7 @@
Make sure you have the following installed before running the smoke test:
- Docker (Give it enough memory and CPU to run ~12 containers, 3 of which are Solr nodes)
More information on required resources can be found here: https://kind.sigs.k8s.io/docs/user/quick-start/#settings-for-docker-desktop
- - Go 1.17
+ - Go 1.19
- Kubectl
- GnuPG
- Helm v3.4.0+
diff --git a/helm/solr-operator/crds/crds.yaml b/helm/solr-operator/crds/crds.yaml
index 2338291..9fbe7c6 100644
--- a/helm/solr-operator/crds/crds.yaml
+++ b/helm/solr-operator/crds/crds.yaml
@@ -20,7 +20,7 @@
annotations:
operator.solr.apache.org/version: v0.7.0-prerelease
argocd.argoproj.io/sync-options: Replace=true
- controller-gen.kubebuilder.io/version: v0.5.0
+ controller-gen.kubebuilder.io/version: v0.6.0
creationTimestamp: null
name: solrbackups.solr.apache.org
spec:
@@ -63,10 +63,14 @@
description: SolrBackup is the Schema for the solrbackups API
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -79,28 +83,42 @@
type: string
type: array
location:
- description: The location to store the backup in the specified backup repository.
+ description: The location to store the backup in the specified backup
+ repository.
type: string
recurrence:
- description: "Set this backup to be taken recurrently, with options for scheduling and storage. \n NOTE: This is only supported for Solr Clouds version 8.9+, as it uses the incremental backup API."
+ description: "Set this backup to be taken recurrently, with options
+ for scheduling and storage. \n NOTE: This is only supported for
+ Solr Clouds version 8.9+, as it uses the incremental backup API."
properties:
disabled:
default: false
- description: Disable the recurring backups. Note this will not affect any currently-running backup.
+ description: Disable the recurring backups. Note this will not
+ affect any currently-running backup.
type: boolean
maxSaved:
default: 5
- description: Define the number of backup points to save for this backup at any given time. The oldest backups will be deleted if too many exist when a backup is taken. If not provided, this defaults to 5.
+ description: Define the number of backup points to save for this
+ backup at any given time. The oldest backups will be deleted
+ if too many exist when a backup is taken. If not provided, this
+ defaults to 5.
minimum: 1
type: integer
schedule:
- description: "Perform a backup on the given schedule, in CRON format. \n Multiple CRON syntaxes are supported - Standard CRON (e.g. \"CRON_TZ=Asia/Seoul 0 6 * * ?\") - Predefined Schedules (e.g. \"@yearly\", \"@weekly\", \"@daily\", etc.) - Intervals (e.g. \"@every 10h30m\") \n For more information please check this reference: https://pkg.go.dev/github.com/robfig/cron/v3?utm_source=godoc#hdr-CRON_Expression_Format"
+ description: "Perform a backup on the given schedule, in CRON
+ format. \n Multiple CRON syntaxes are supported - Standard
+ CRON (e.g. \"CRON_TZ=Asia/Seoul 0 6 * * ?\") - Predefined
+ Schedules (e.g. \"@yearly\", \"@weekly\", \"@daily\", etc.)
+ \ - Intervals (e.g. \"@every 10h30m\") \n For more information
+ please check this reference: https://pkg.go.dev/github.com/robfig/cron/v3?utm_source=godoc#hdr-CRON_Expression_Format"
type: string
required:
- schedule
type: object
repositoryName:
- description: The name of the repository to use for the backup. Defaults to "legacy_local_repository" if not specified (the auto-configured repository for legacy singleton volumes).
+ description: The name of the repository to use for the backup. Defaults
+ to "legacy_local_repository" if not specified (the auto-configured
+ repository for legacy singleton volumes).
maxLength: 100
minLength: 1
pattern: '[a-zA-Z0-9]([-_a-zA-Z0-9]*[a-zA-Z0-9])?'
@@ -120,7 +138,8 @@
collectionBackupStatuses:
description: The status of each collection's backup progress
items:
- description: CollectionBackupStatus defines the progress of a Solr Collection's backup
+ description: CollectionBackupStatus defines the progress of a Solr
+ Collection's backup
properties:
asyncBackupStatus:
description: The status of the asynchronous backup call to solr
@@ -162,24 +181,29 @@
history:
description: The status history of recurring backups
items:
- description: IndividualSolrBackupStatus defines the observed state of a single issued SolrBackup
+ description: IndividualSolrBackupStatus defines the observed state
+ of a single issued SolrBackup
properties:
collectionBackupStatuses:
description: The status of each collection's backup progress
items:
- description: CollectionBackupStatus defines the progress of a Solr Collection's backup
+ description: CollectionBackupStatus defines the progress of
+ a Solr Collection's backup
properties:
asyncBackupStatus:
- description: The status of the asynchronous backup call to solr
+ description: The status of the asynchronous backup call
+ to solr
type: string
backupName:
- description: BackupName of this collection's backup in Solr
+ description: BackupName of this collection's backup in
+ Solr
type: string
collection:
description: Solr Collection name
type: string
finishTimestamp:
- description: Time that the collection backup finished at
+ description: Time that the collection backup finished
+ at
format: date-time
type: string
finished:
@@ -252,7 +276,7 @@
annotations:
operator.solr.apache.org/version: v0.7.0-prerelease
argocd.argoproj.io/sync-options: Replace=true
- controller-gen.kubebuilder.io/version: v0.5.0
+ controller-gen.kubebuilder.io/version: v0.6.0
creationTimestamp: null
name: solrclouds.solr.apache.org
spec:
@@ -300,10 +324,14 @@
description: SolrCloud is the Schema for the solrclouds API
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -311,36 +339,50 @@
description: SolrCloudSpec defines the desired state of SolrCloud
properties:
additionalLibs:
- description: 'List of paths in the Solr Docker image to load in the classpath. Note: Solr Modules will be auto-loaded if specified in the "solrModules" property. There is no need to specify them here as well.'
+ description: 'List of paths in the Solr Docker image to load in the
+ classpath. Note: Solr Modules will be auto-loaded if specified in
+ the "solrModules" property. There is no need to specify them here
+ as well.'
items:
type: string
type: array
backupRepositories:
- description: Allows specification of multiple different "repositories" for Solr to use when backing up data.
+ description: Allows specification of multiple different "repositories"
+ for Solr to use when backing up data.
items:
maxProperties: 2
minProperties: 2
properties:
gcs:
- description: A GCSRepository for Solr to use when backing up and restoring collections.
+ description: A GCSRepository for Solr to use when backing up
+ and restoring collections.
properties:
baseLocation:
- description: An already-created chroot within the bucket to store data in. Defaults to the root path "/" if not specified.
+ description: An already-created chroot within the bucket
+ to store data in. Defaults to the root path "/" if not
+ specified.
type: string
bucket:
- description: The name of the GCS bucket that all backup data will be stored in
+ description: The name of the GCS bucket that all backup
+ data will be stored in
type: string
gcsCredentialSecret:
- description: The name & key of a Kubernetes secret holding a Google cloud service account key. Must be set unless deployed in GKE and making use of Google's "Workplace Identity" feature.
+ description: The name & key of a Kubernetes secret holding
+ a Google cloud service account key. Must be set unless
+ deployed in GKE and making use of Google's "Workplace
+ Identity" feature.
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must
+ be defined
type: boolean
required:
- key
@@ -349,89 +391,124 @@
- bucket
type: object
name:
- description: 'A name used to identify this local storage profile. Values should follow RFC-1123. (See here for more details: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names)'
+ description: 'A name used to identify this local storage profile. Values
+ should follow RFC-1123. (See here for more details: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names)'
maxLength: 100
minLength: 1
pattern: '[a-zA-Z0-9]([-_a-zA-Z0-9]*[a-zA-Z0-9])?'
type: string
s3:
- description: An S3Repository for Solr to use when backing up and restoring collections.
+ description: An S3Repository for Solr to use when backing up
+ and restoring collections.
properties:
baseLocation:
- description: An already-created chroot within the bucket to store data in. Defaults to the root path "/" if not specified.
+ description: An already-created chroot within the bucket
+ to store data in. Defaults to the root path "/" if not
+ specified.
type: string
bucket:
- description: The name of the S3 bucket that all backup data will be stored in
+ description: The name of the S3 bucket that all backup data
+ will be stored in
type: string
credentials:
- description: "Options for specifying S3Credentials. This is optional in case you want to mount this information yourself. However, if you do not include these credentials, and you do not load them yourself via a mount or EnvVars, you will likely see errors when taking s3 backups. \n If running in EKS, you can create an IAMServiceAccount that uses a role permissioned for this S3 bucket. Then use that serviceAccountName for your SolrCloud, and the credentials should be auto-populated."
+ description: "Options for specifying S3Credentials. This
+ is optional in case you want to mount this information
+ yourself. However, if you do not include these credentials,
+ and you do not load them yourself via a mount or EnvVars,
+ you will likely see errors when taking s3 backups. \n
+ If running in EKS, you can create an IAMServiceAccount
+ that uses a role permissioned for this S3 bucket. Then
+ use that serviceAccountName for your SolrCloud, and the
+ credentials should be auto-populated."
properties:
accessKeyIdSecret:
- description: The name & key of a Kubernetes secret holding an AWS Access Key ID
+ description: The name & key of a Kubernetes secret holding
+ an AWS Access Key ID
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key
+ must be defined
type: boolean
required:
- key
type: object
credentialsFileSecret:
- description: The name & key of a Kubernetes secret holding an AWS credentials file
+ description: The name & key of a Kubernetes secret holding
+ an AWS credentials file
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key
+ must be defined
type: boolean
required:
- key
type: object
secretAccessKeySecret:
- description: The name & key of a Kubernetes secret holding an AWS Secret Access Key
+ description: The name & key of a Kubernetes secret holding
+ an AWS Secret Access Key
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key
+ must be defined
type: boolean
required:
- key
type: object
sessionTokenSecret:
- description: The name & key of a Kubernetes secret holding an AWS Session Token
+ description: The name & key of a Kubernetes secret holding
+ an AWS Session Token
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key
+ must be defined
type: boolean
required:
- key
type: object
type: object
endpoint:
- description: The full endpoint URL to use when connecting with S3 (or a supported S3 compatible interface)
+ description: The full endpoint URL to use when connecting
+ with S3 (or a supported S3 compatible interface)
type: string
proxyUrl:
- description: The full proxy URL to use when connecting with S3
+ description: The full proxy URL to use when connecting with
+ S3
type: string
region:
description: The S3 region to store the backup data in
@@ -441,66 +518,106 @@
- region
type: object
volume:
- description: Allows specification of a "repository" for Solr to use when backing up data "locally".
+ description: Allows specification of a "repository" for Solr
+ to use when backing up data "locally".
properties:
directory:
- description: Select a custom directory name to mount the backup/restore data in the given volume. If not specified, then the name of the solrcloud will be used by default.
+ description: Select a custom directory name to mount the
+ backup/restore data in the given volume. If not specified,
+ then the name of the solrcloud will be used by default.
type: string
source:
- description: 'This is a volumeSource for a volume that will be mounted to all solrNodes to store backups and load restores. The data within the volume will be namespaced for this instance, so feel free to use the same volume for multiple clouds. Since the volume will be mounted to all solrNodes, it must be able to be written from multiple pods. If a PVC reference is given, the PVC must have `accessModes: - ReadWriteMany`. Other options are to use a NFS volume.'
+ description: 'This is a volumeSource for a volume that will
+ be mounted to all solrNodes to store backups and load
+ restores. The data within the volume will be namespaced
+ for this instance, so feel free to use the same volume
+ for multiple clouds. Since the volume will be mounted
+ to all solrNodes, it must be able to be written from multiple
+ pods. If a PVC reference is given, the PVC must have `accessModes:
+ - ReadWriteMany`. Other options are to use a NFS volume.'
properties:
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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 TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume that
+ you want to mount. Tip: Ensure that the filesystem
+ 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
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: '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).'
+ description: '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).'
format: int32
type: integer
readOnly:
- description: 'Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'Specify "true" to force and set the
+ ReadOnly property in VolumeMounts to "true". If
+ omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: boolean
volumeID:
- description: 'Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'Unique ID of the persistent disk resource
+ in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: string
required:
- volumeID
type: object
azureDisk:
- description: AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+ description: AzureDisk represents an Azure Data Disk
+ mount on the host and bind mount to the pod.
properties:
cachingMode:
- description: 'Host Caching mode: None, Read Only, Read Write.'
+ description: 'Host Caching mode: None, Read Only,
+ Read Write.'
type: string
diskName:
- description: The Name of the data disk in the blob storage
+ description: The Name of the data disk in the blob
+ storage
type: string
diskURI:
description: The URI the data disk in the blob storage
type: string
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must be a
+ filesystem type supported by the host operating
+ system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified.
type: string
kind:
- description: 'Expected values 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'
+ description: 'Expected values 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'
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write). ReadOnly
+ here will force the ReadOnly setting in VolumeMounts.
type: boolean
required:
- diskName
- diskURI
type: object
azureFile:
- description: AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
+ description: AzureFile represents an Azure File Service
+ mount on the host and bind mount to the pod.
properties:
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write). ReadOnly
+ here will force the ReadOnly setting in VolumeMounts.
type: boolean
secretName:
- description: the name of secret that contains Azure Storage Account Name and Key
+ description: the name of secret that contains Azure
+ Storage Account Name and Key
type: string
shareName:
description: Share Name
@@ -510,78 +627,136 @@
- shareName
type: object
cephfs:
- description: CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
+ description: CephFS represents a Ceph FS mount on the
+ host that shares a pod's lifetime
properties:
monitors:
- description: 'Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'Required: Monitors is a collection
+ of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
items:
type: string
type: array
path:
- description: 'Optional: Used as the mounted root, rather than the full Ceph tree, default is /'
+ description: 'Optional: Used as the mounted root,
+ rather than the full Ceph tree, default is /'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
secretFile:
- description: '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'
+ description: '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'
type: string
secretRef:
- description: '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'
+ description: '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'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
user:
- description: 'Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'Optional: User is the rados user name,
+ default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
required:
- monitors
type: object
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'
+ description: 'Cinder represents a cinder volume attached
+ and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
properties:
fsType:
- description: 'Filesystem type to mount. Must be a filesystem 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'
+ description: 'Filesystem type to mount. Must be
+ a filesystem 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'
type: string
readOnly:
- description: 'Optional: 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'
+ description: 'Optional: 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'
type: boolean
secretRef:
- description: 'Optional: points to a secret object containing parameters used to connect to OpenStack.'
+ description: 'Optional: points to a secret object
+ containing parameters used to connect to OpenStack.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
volumeID:
- description: 'volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'volume id used to identify the volume
+ in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
required:
- volumeID
type: object
configMap:
- description: ConfigMap represents a configMap that should populate this volume
+ description: ConfigMap represents a configMap that should
+ populate this volume
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: 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 '..'.
+ description: 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
+ '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to a path within
+ a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -589,81 +764,143 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its keys must be defined
+ description: Specify whether the ConfigMap or its
+ keys must be defined
type: boolean
type: object
csi:
- description: CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
+ description: CSI (Container Storage Interface) represents
+ ephemeral storage that is handled by certain external
+ CSI drivers (Beta feature).
properties:
driver:
- description: Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
+ description: Driver is the name of the CSI driver
+ that handles this volume. Consult with your admin
+ for the correct name as registered in the cluster.
type: string
fsType:
- description: Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
+ description: Filesystem type to mount. Ex. "ext4",
+ "xfs", "ntfs". If not provided, the empty value
+ is passed to the associated CSI driver which will
+ determine the default filesystem to apply.
type: string
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.
+ 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.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
readOnly:
- description: Specifies a read-only configuration for the volume. Defaults to false (read/write).
+ description: Specifies a read-only configuration
+ for the volume. Defaults to false (read/write).
type: boolean
volumeAttributes:
additionalProperties:
type: string
- description: VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
+ description: VolumeAttributes stores driver-specific
+ properties that are passed to the CSI driver.
+ Consult your driver's documentation for supported
+ values.
type: object
required:
- driver
type: object
downwardAPI:
- description: DownwardAPI represents downward API about the pod that should populate this volume
+ description: DownwardAPI represents downward API about
+ the pod that should populate this volume
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: Items is a list of downward API volume file
+ description: Items is a list of downward API volume
+ file
items:
- description: DownwardAPIVolumeFile represents information to create the file containing the pod field
+ description: DownwardAPIVolumeFile represents
+ information to create the file containing the
+ pod field
properties:
fieldRef:
- description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
+ description: 'Required: Selects a field of
+ the pod: only annotations, labels, name
+ and namespace are supported.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema the
+ FieldPath is written in terms of, defaults
+ to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to select
+ in the specified API version.
type: string
required:
- fieldPath
type: object
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative path name 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 ''..'''
+ description: 'Required: Path is the relative
+ path name 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 ''..'''
type: string
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.'
+ description: 'Selects a resource of the container:
+ only resources limits and requests (limits.cpu,
+ limits.memory, requests.cpu and requests.memory)
+ are currently supported.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required
+ for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output format
+ of the exposed resources, defaults to
+ "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -678,57 +915,140 @@
type: array
type: object
emptyDir:
- description: 'EmptyDir represents a temporary directory that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
+ description: 'EmptyDir represents a temporary directory
+ that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
properties:
medium:
- description: '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'
+ description: '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'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
+ description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: "Ephemeral represents a volume that is handled by a cluster storage driver (Alpha feature). 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."
+ description: "Ephemeral represents a volume that is
+ handled by a cluster storage driver (Alpha feature).
+ 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."
properties:
readOnly:
- description: Specifies a read-only configuration for the volume. Defaults to false (read/write).
+ description: Specifies a read-only configuration
+ for the volume. Defaults to false (read/write).
type: boolean
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). \n 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. \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."
+ 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). \n 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. \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."
properties:
metadata:
- description: 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.
+ description: 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.
type: object
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.
+ 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.
properties:
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'
+ description: 'AccessModes contains the desired
+ access modes the volume should have. More
+ info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. 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.'
+ description: 'This field can be used to
+ specify either: * An existing VolumeSnapshot
+ object (snapshot.storage.k8s.io/VolumeSnapshot)
+ * An existing PVC (PersistentVolumeClaim)
+ * An existing custom resource that implements
+ data population (Alpha) In order to use
+ custom resource types that implement data
+ population, the AnyVolumeDataSource feature
+ gate must be enabled. 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.'
properties:
apiGroup:
- description: 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.
+ description: 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.
type: string
kind:
- description: Kind is the type of resource being referenced
+ description: Kind is the type of resource
+ being referenced
type: string
name:
- description: Name is the name of resource being referenced
+ description: Name is the name of resource
+ being referenced
type: string
required:
- kind
- name
type: object
resources:
- description: 'Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'Resources represents the minimum
+ resources the volume should have. More
+ info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
@@ -737,7 +1057,9 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum
+ amount of compute resources allowed.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -746,25 +1068,49 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
selector:
- description: A label query over volumes to consider for binding.
+ description: A label query over volumes
+ to consider for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The
+ requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a set
+ of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -776,17 +1122,29 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
storageClassName:
- description: 'Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'Name of the StorageClass required
+ by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
+ description: volumeMode defines what type
+ of volume is required by the claim. Value
+ of Filesystem is implied when not included
+ in claim spec.
type: string
volumeName:
- description: VolumeName is the binding reference to the PersistentVolume backing this claim.
+ description: VolumeName is the binding reference
+ to the PersistentVolume backing this claim.
type: string
type: object
required:
@@ -794,90 +1152,151 @@
type: object
type: object
fc:
- description: FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
+ description: FC represents a Fibre Channel resource
+ that is attached to a kubelet's host machine and then
+ exposed to the pod.
properties:
fsType:
- description: 'Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type to mount. Must be
+ a filesystem type supported by the host operating
+ system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified. TODO: how
+ do we prevent errors in the filesystem from compromising
+ the machine'
type: string
lun:
description: 'Optional: FC target lun number'
format: int32
type: integer
readOnly:
- description: 'Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'Optional: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.'
type: boolean
targetWWNs:
- description: 'Optional: FC target worldwide names (WWNs)'
+ description: 'Optional: FC target worldwide names
+ (WWNs)'
items:
type: string
type: array
wwids:
- description: 'Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.'
+ description: 'Optional: FC volume world wide identifiers
+ (wwids) Either wwids or combination of targetWWNs
+ and lun must be set, but not both simultaneously.'
items:
type: string
type: array
type: object
flexVolume:
- description: FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
+ description: FlexVolume represents a generic volume
+ resource that is provisioned/attached using an exec
+ based plugin.
properties:
driver:
- description: Driver is the name of the driver to use for this volume.
+ description: Driver is the name of the driver to
+ use for this volume.
type: string
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
+ description: Filesystem type to mount. Must be a
+ filesystem type supported by the host operating
+ system. Ex. "ext4", "xfs", "ntfs". The default
+ filesystem depends on FlexVolume script.
type: string
options:
additionalProperties:
type: string
- description: 'Optional: Extra command options if any.'
+ description: 'Optional: Extra command options if
+ any.'
type: object
readOnly:
- description: 'Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'Optional: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.'
type: boolean
secretRef:
- description: '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.'
+ description: '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.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
required:
- driver
type: object
flocker:
- description: Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
+ description: Flocker represents a Flocker volume attached
+ to a kubelet's host machine. This depends on the Flocker
+ control service being running
properties:
datasetName:
- description: Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
+ description: Name of the dataset stored as metadata
+ -> name on the dataset for Flocker should be considered
+ as deprecated
type: string
datasetUUID:
- description: UUID of the dataset. This is unique identifier of a Flocker dataset
+ description: UUID of the dataset. This is unique
+ identifier of a Flocker dataset
type: string
type: object
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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 TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume that
+ you want to mount. Tip: Ensure that the filesystem
+ 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
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: '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). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: '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). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
format: int32
type: integer
pdName:
- description: 'Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'Unique name of the PD resource in
+ GCE. Used to identify the disk in GCE. More info:
+ https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: string
readOnly:
- description: 'ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'ReadOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false. More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: boolean
required:
- pdName
type: object
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.'
+ 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.'
properties:
directory:
- description: 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.
+ description: 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.
type: string
repository:
description: Repository URL
@@ -889,75 +1308,116 @@
- repository
type: object
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'
+ 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'
properties:
endpoints:
- description: 'EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'EndpointsName is the endpoint name
+ that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
path:
- description: 'Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'Path is the Glusterfs volume path.
+ More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
required:
- endpoints
- path
type: object
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.'
+ 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.'
properties:
path:
- description: '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'
+ description: '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'
type: string
type:
- description: 'Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
+ description: 'Type for HostPath Volume Defaults
+ to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
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'
+ 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'
properties:
chapAuthDiscovery:
- description: whether support iSCSI Discovery CHAP authentication
+ description: whether support iSCSI Discovery CHAP
+ authentication
type: boolean
chapAuthSession:
- description: whether support iSCSI Session CHAP authentication
+ description: whether support iSCSI Session CHAP
+ authentication
type: boolean
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume that
+ you want to mount. Tip: Ensure that the filesystem
+ 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#iscsi
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
initiatorName:
- description: Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
+ description: Custom iSCSI Initiator Name. If initiatorName
+ is specified with iscsiInterface simultaneously,
+ new iSCSI interface <target portal>:<volume name>
+ will be created for the connection.
type: string
iqn:
description: Target iSCSI Qualified Name.
type: string
iscsiInterface:
- description: iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
+ description: iSCSI Interface Name that uses an iSCSI
+ transport. Defaults to 'default' (tcp).
type: string
lun:
description: iSCSI Target Lun number.
format: int32
type: integer
portals:
- description: 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).
+ description: 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).
items:
type: string
type: array
readOnly:
- description: ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
+ description: ReadOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
type: boolean
secretRef:
- description: CHAP Secret for iSCSI target and initiator authentication
+ description: CHAP Secret for iSCSI target and initiator
+ authentication
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
targetPortal:
- description: 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).
+ description: 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).
type: string
required:
- iqn
@@ -965,89 +1425,154 @@
- targetPortal
type: object
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'
+ 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'
properties:
path:
- description: 'Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'Path that is exported by the NFS server.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
server:
- description: 'Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'Server is the hostname or IP address
+ of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- path
- server
type: object
persistentVolumeClaim:
- description: 'PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'PersistentVolumeClaimVolumeSource represents
+ a reference to a PersistentVolumeClaim in the same
+ namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
claimName:
- description: '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'
+ description: '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'
type: string
readOnly:
- description: Will force the ReadOnly setting in VolumeMounts. Default false.
+ description: Will force the ReadOnly setting in
+ VolumeMounts. Default false.
type: boolean
required:
- claimName
type: object
photonPersistentDisk:
- description: PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
+ description: PhotonPersistentDisk represents a PhotonController
+ persistent disk attached and mounted on kubelets host
+ machine
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must be a
+ filesystem type supported by the host operating
+ system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified.
type: string
pdID:
- description: ID that identifies Photon Controller persistent disk
+ description: ID that identifies Photon Controller
+ persistent disk
type: string
required:
- pdID
type: object
portworxVolume:
- description: PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
+ description: PortworxVolume represents a portworx volume
+ attached and mounted on kubelets host machine
properties:
fsType:
- description: FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
+ description: FSType represents the filesystem type
+ to mount Must be a filesystem type supported by
+ the host operating system. Ex. "ext4", "xfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write). ReadOnly
+ here will force the ReadOnly setting in VolumeMounts.
type: boolean
volumeID:
- description: VolumeID uniquely identifies a Portworx volume
+ description: VolumeID uniquely identifies a Portworx
+ volume
type: string
required:
- volumeID
type: object
projected:
- description: Items for all in one resources secrets, configmaps, and downward API
+ description: Items for all in one resources secrets,
+ configmaps, and downward API
properties:
defaultMode:
- description: 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.
+ description: 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.
format: int32
type: integer
sources:
description: list of volume projections
items:
- description: Projection that may be projected along with other supported volume types
+ description: Projection that may be projected
+ along with other supported volume types
properties:
configMap:
- description: information about the configMap data to project
+ description: information about the configMap
+ data to project
properties:
items:
- description: 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 '..'.
+ description: 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 '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to a
+ path within a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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
+ '..'.
type: string
required:
- key
@@ -1055,54 +1580,98 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its keys must be defined
+ description: Specify whether the ConfigMap
+ or its keys must be defined
type: boolean
type: object
downwardAPI:
- description: information about the downwardAPI data to project
+ description: information about the downwardAPI
+ data to project
properties:
items:
- description: Items is a list of DownwardAPIVolume file
+ description: Items is a list of DownwardAPIVolume
+ file
items:
- description: DownwardAPIVolumeFile represents information to create the file containing the pod field
+ description: DownwardAPIVolumeFile represents
+ information to create the file containing
+ the pod field
properties:
fieldRef:
- description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
+ description: 'Required: Selects
+ a field of the pod: only annotations,
+ labels, name and namespace are
+ supported.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the
+ schema the FieldPath is written
+ in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field
+ to select in the specified
+ API version.
type: string
required:
- fieldPath
type: object
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative path name 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 ''..'''
+ description: 'Required: Path is the
+ relative path name 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 ''..'''
type: string
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.'
+ description: 'Selects a resource
+ of the container: only resources
+ limits and requests (limits.cpu,
+ limits.memory, requests.cpu and
+ requests.memory) are currently
+ supported.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name:
+ required for volumes, optional
+ for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output
+ format of the exposed resources,
+ defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
- description: 'Required: resource to select'
+ description: 'Required: resource
+ to select'
type: string
required:
- resource
@@ -1113,22 +1682,54 @@
type: array
type: object
secret:
- description: information about the secret data to project
+ description: information about the secret
+ data to project
properties:
items:
- description: 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 '..'.
+ description: 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 '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to a
+ path within a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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
+ '..'.
type: string
required:
- key
@@ -1136,24 +1737,47 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret
+ or its key must be defined
type: boolean
type: object
serviceAccountToken:
- description: information about the serviceAccountToken data to project
+ description: information about the serviceAccountToken
+ data to project
properties:
audience:
- description: 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.
+ description: 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.
type: string
expirationSeconds:
- description: 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.
+ description: 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.
format: int64
type: integer
path:
- description: Path is the path relative to the mount point of the file to project the token into.
+ description: Path is the path relative
+ to the mount point of the file to project
+ the token into.
type: string
required:
- path
@@ -1162,103 +1786,155 @@
type: array
type: object
quobyte:
- description: Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
+ description: Quobyte represents a Quobyte mount on the
+ host that shares a pod's lifetime
properties:
group:
- description: Group to map volume access to Default is no group
+ description: Group to map volume access to Default
+ is no group
type: string
readOnly:
- description: ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
+ description: ReadOnly here will force the Quobyte
+ volume to be mounted with read-only permissions.
+ Defaults to false.
type: boolean
registry:
- description: 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
+ description: 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
type: string
tenant:
- description: Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ description: Tenant owning the given Quobyte volume
+ in the Backend Used with dynamically provisioned
+ Quobyte volumes, value is set by the plugin
type: string
user:
- description: User to map volume access to Defaults to serivceaccount user
+ description: User to map volume access to Defaults
+ to serivceaccount user
type: string
volume:
- description: Volume is a string that references an already created Quobyte volume by name.
+ description: Volume is a string that references
+ an already created Quobyte volume by name.
type: string
required:
- registry
- volume
type: object
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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#rbd TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume that
+ you want to mount. Tip: Ensure that the filesystem
+ 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#rbd
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
image:
description: 'The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
keyring:
- description: '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'
+ description: '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'
type: string
monitors:
- description: 'A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'A collection of Ceph monitors. More
+ info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
items:
type: string
type: array
pool:
- description: 'The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'The rados pool name. Default is rbd.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
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'
+ 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'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
user:
- description: 'The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'The rados user name. Default is admin.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- image
- monitors
type: object
scaleIO:
- description: ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
+ description: ScaleIO represents a ScaleIO persistent
+ volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
+ description: Filesystem type to mount. Must be a
+ filesystem type supported by the host operating
+ system. Ex. "ext4", "xfs", "ntfs". Default is
+ "xfs".
type: string
gateway:
- description: The host address of the ScaleIO API Gateway.
+ description: The host address of the ScaleIO API
+ Gateway.
type: string
protectionDomain:
- description: The name of the ScaleIO Protection Domain for the configured storage.
+ description: The name of the ScaleIO Protection
+ Domain for the configured storage.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write). ReadOnly
+ here will force the ReadOnly setting in VolumeMounts.
type: boolean
secretRef:
- description: SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
+ description: SecretRef references to the secret
+ for ScaleIO user and other sensitive information.
+ If this is not provided, Login operation will
+ fail.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
sslEnabled:
- description: Flag to enable/disable SSL communication with Gateway, default false
+ description: Flag to enable/disable SSL communication
+ with Gateway, default false
type: boolean
storageMode:
- description: Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
+ description: Indicates whether the storage for a
+ volume should be ThickProvisioned or ThinProvisioned.
+ Default is ThinProvisioned.
type: string
storagePool:
- description: The ScaleIO Storage Pool associated with the protection domain.
+ description: The ScaleIO Storage Pool associated
+ with the protection domain.
type: string
system:
- description: The name of the storage system as configured in ScaleIO.
+ description: The name of the storage system as configured
+ in ScaleIO.
type: string
volumeName:
- description: The name of a volume already created in the ScaleIO system that is associated with this volume source.
+ description: The name of a volume already created
+ in the ScaleIO system that is associated with
+ this volume source.
type: string
required:
- gateway
@@ -1266,26 +1942,59 @@
- system
type: object
secret:
- description: 'Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'Secret represents a secret that should
+ populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: 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 '..'.
+ description: 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
+ '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to a path within
+ a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -1293,49 +2002,78 @@
type: object
type: array
optional:
- description: Specify whether the Secret or its keys must be defined
+ description: Specify whether the Secret or its keys
+ must be defined
type: boolean
secretName:
- description: 'Name of the secret in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'Name of the secret in the pod''s namespace
+ to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
type: string
type: object
storageos:
- description: StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
+ description: StorageOS represents a StorageOS volume
+ attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must be a
+ filesystem type supported by the host operating
+ system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write). ReadOnly
+ here will force the ReadOnly setting in VolumeMounts.
type: boolean
secretRef:
- description: SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
+ description: SecretRef specifies the secret to use
+ for obtaining the StorageOS API credentials. If
+ not specified, default values will be attempted.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
volumeName:
- description: VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
+ description: VolumeName is the human-readable name
+ of the StorageOS volume. Volume names are only
+ unique within a namespace.
type: string
volumeNamespace:
- description: 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 do not pre-exist within StorageOS will be created.
+ description: 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 do
+ not pre-exist within StorageOS will be created.
type: string
type: object
vsphereVolume:
- description: VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
+ description: VsphereVolume represents a vSphere volume
+ attached and mounted on kubelets host machine
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must be a
+ filesystem type supported by the host operating
+ system. Ex. "ext4", "xfs", "ntfs". Implicitly
+ inferred to be "ext4" if unspecified.
type: string
storagePolicyID:
- description: Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
+ description: Storage Policy Based Management (SPBM)
+ profile ID associated with the StoragePolicyName.
type: string
storagePolicyName:
- description: Storage Policy Based Management (SPBM) profile name.
+ description: Storage Policy Based Management (SPBM)
+ profile name.
type: string
volumePath:
- description: Path that identifies vSphere volume vmdk
+ description: Path that identifies vSphere volume
+ vmdk
type: string
required:
- volumePath
@@ -1352,12 +2090,15 @@
- name
x-kubernetes-list-type: map
busyBoxImage:
- description: ContainerImage defines the fields needed for a Docker repository image. The format here matches the predominant format used in Helm charts.
+ description: ContainerImage defines the fields needed for a Docker
+ repository image. The format here matches the predominant format
+ used in Helm charts.
properties:
imagePullSecret:
type: string
pullPolicy:
- description: PullPolicy describes a policy for if/when to pull a container image
+ description: PullPolicy describes a policy for if/when to pull
+ a container image
type: string
repository:
type: string
@@ -1365,10 +2106,12 @@
type: string
type: object
customSolrKubeOptions:
- description: Provide custom options for kubernetes objects created for the Solr Cloud.
+ description: Provide custom options for kubernetes objects created
+ for the Solr Cloud.
properties:
commonServiceOptions:
- description: CommonServiceOptions defines the custom options for the common solrCloud Service.
+ description: CommonServiceOptions defines the custom options for
+ the common solrCloud Service.
properties:
annotations:
additionalProperties:
@@ -1382,7 +2125,8 @@
type: object
type: object
configMapOptions:
- description: ServiceOptions defines the custom options for the solrCloud ConfigMap.
+ description: ServiceOptions defines the custom options for the
+ solrCloud ConfigMap.
properties:
annotations:
additionalProperties:
@@ -1395,11 +2139,13 @@
description: Labels to be added for the ConfigMap.
type: object
providedConfigMap:
- description: Name of a user provided ConfigMap in the same namespace containing a custom solr.xml
+ description: Name of a user provided ConfigMap in the same
+ namespace containing a custom solr.xml
type: string
type: object
headlessServiceOptions:
- description: HeadlessServiceOptions defines the custom options for the headless solrCloud Service.
+ description: HeadlessServiceOptions defines the custom options
+ for the headless solrCloud Service.
properties:
annotations:
additionalProperties:
@@ -1413,7 +2159,8 @@
type: object
type: object
ingressOptions:
- description: IngressOptions defines the custom options for the solrCloud Ingress.
+ description: IngressOptions defines the custom options for the
+ solrCloud Ingress.
properties:
annotations:
additionalProperties:
@@ -1421,7 +2168,9 @@
description: Annotations to be added for the Ingress.
type: object
ingressClassName:
- description: IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource.
+ description: IngressClassName is the name of the IngressClass
+ cluster resource. The associated IngressClass defines which
+ controller will implement the resource.
maxLength: 63
minLength: 1
pattern: '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*'
@@ -1433,7 +2182,10 @@
type: object
type: object
nodeServiceOptions:
- description: NodeServiceOptions defines the custom options for the individual solrCloud Node services, if they are created. These services will only be created when exposing SolrNodes externally via an Ingress in the AddressabilityOptions.
+ description: NodeServiceOptions defines the custom options for
+ the individual solrCloud Node services, if they are created.
+ These services will only be created when exposing SolrNodes
+ externally via an Ingress in the AddressabilityOptions.
properties:
annotations:
additionalProperties:
@@ -1447,35 +2199,69 @@
type: object
type: object
podOptions:
- description: SolrPodOptions defines the custom options for solrCloud pods.
+ description: SolrPodOptions defines the custom options for solrCloud
+ pods.
properties:
affinity:
description: The scheduling constraints on pods.
properties:
nodeAffinity:
- description: Describes node affinity scheduling rules for the pod.
+ description: Describes node affinity scheduling rules
+ for the pod.
properties:
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.
+ 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.
items:
- 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).
+ 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).
properties:
preference:
- description: A node selector term, associated with the corresponding weight.
+ description: A node selector term, associated
+ with the corresponding weight.
properties:
matchExpressions:
- description: A list of node selector requirements by node's labels.
+ description: A list of node selector requirements
+ by node's labels.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that the
+ selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's relationship
+ to a set of values. Valid operators
+ are In, NotIn, Exists, DoesNotExist.
+ Gt, and Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -1485,18 +2271,35 @@
type: object
type: array
matchFields:
- description: A list of node selector requirements by node's fields.
+ description: A list of node selector requirements
+ by node's fields.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that the
+ selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's relationship
+ to a set of values. Valid operators
+ are In, NotIn, Exists, DoesNotExist.
+ Gt, and Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -1507,7 +2310,9 @@
type: array
type: object
weight:
- description: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
+ description: Weight associated with matching
+ the corresponding nodeSelectorTerm, in the
+ range 1-100.
format: int32
type: integer
required:
@@ -1516,26 +2321,53 @@
type: object
type: array
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.
+ 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.
properties:
nodeSelectorTerms:
- description: Required. A list of node selector terms. The terms are ORed.
+ description: Required. A list of node selector
+ terms. The terms are ORed.
items:
- 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.
+ 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.
properties:
matchExpressions:
- description: A list of node selector requirements by node's labels.
+ description: A list of node selector requirements
+ by node's labels.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that the
+ selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's relationship
+ to a set of values. Valid operators
+ are In, NotIn, Exists, DoesNotExist.
+ Gt, and Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -1545,18 +2377,35 @@
type: object
type: array
matchFields:
- description: A list of node selector requirements by node's fields.
+ description: A list of node selector requirements
+ by node's fields.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that the
+ selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's relationship
+ to a set of values. Valid operators
+ are In, NotIn, Exists, DoesNotExist.
+ Gt, and Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -1572,32 +2421,67 @@
type: object
type: object
podAffinity:
- description: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
+ description: Describes pod affinity scheduling rules (e.g.
+ co-locate this pod in the same node, zone, etc. as some
+ other pod(s)).
properties:
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 has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
+ 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 has pods which matches the corresponding
+ podAffinityTerm; the node(s) with the highest sum
+ are the most preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched WeightedPodAffinityTerm
+ fields are added per-node to find the most preferred
+ node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated with the corresponding weight.
+ description: Required. A pod affinity term,
+ associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of
+ resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The
+ requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a set
+ of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -1609,22 +2493,42 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which
+ namespaces the labelSelector applies to
+ (matches against); null or empty list
+ means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located
+ (affinity) or not co-located (anti-affinity)
+ with the pods matching the labelSelector
+ in the specified namespaces, where co-located
+ is defined as running on a node whose
+ value of the label with key topologyKey
+ matches that of any node on which any
+ of the selected pods is running. Empty
+ topologyKey is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
+ description: weight associated with matching
+ the corresponding podAffinityTerm, in the
+ range 1-100.
format: int32
type: integer
required:
@@ -1633,26 +2537,59 @@
type: object
type: array
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 a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
+ 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 a pod label update), the system may or may
+ not try to eventually evict the pod from its node.
+ When there are multiple elements, the lists of nodes
+ corresponding to each podAffinityTerm are intersected,
+ i.e. all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
+ description: Defines a set of pods (namely those
+ matching the labelSelector relative to the given
+ namespace(s)) that this pod should be co-located
+ (affinity) or not co-located (anti-affinity) with,
+ where co-located is defined as running on a node
+ whose value of the label with key <topologyKey>
+ matches that of any node on which a pod of the
+ set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of resources,
+ in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The requirements
+ are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label key
+ that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a
+ key's relationship to a set of values.
+ Valid operators are In, NotIn, Exists
+ and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -1664,16 +2601,30 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which namespaces
+ the labelSelector applies to (matches against);
+ null or empty list means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity)
+ or not co-located (anti-affinity) with the
+ pods matching the labelSelector in the specified
+ namespaces, where co-located is defined as
+ running on a node whose value of the label
+ with key topologyKey matches that of any node
+ on which any of the selected pods is running.
+ Empty topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -1681,32 +2632,67 @@
type: array
type: object
podAntiAffinity:
- description: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
+ description: Describes pod anti-affinity scheduling rules
+ (e.g. avoid putting this pod in the same node, zone,
+ etc. as some other pod(s)).
properties:
preferredDuringSchedulingIgnoredDuringExecution:
- description: The scheduler will prefer to schedule pods to nodes that satisfy the anti-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 anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
+ description: The scheduler will prefer to schedule
+ pods to nodes that satisfy the anti-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 anti-affinity
+ expressions, etc.), compute a sum by iterating through
+ the elements of this field and adding "weight" to
+ the sum if the node has pods which matches the corresponding
+ podAffinityTerm; the node(s) with the highest sum
+ are the most preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched WeightedPodAffinityTerm
+ fields are added per-node to find the most preferred
+ node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated with the corresponding weight.
+ description: Required. A pod affinity term,
+ associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of
+ resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The
+ requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a set
+ of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -1718,22 +2704,42 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which
+ namespaces the labelSelector applies to
+ (matches against); null or empty list
+ means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located
+ (affinity) or not co-located (anti-affinity)
+ with the pods matching the labelSelector
+ in the specified namespaces, where co-located
+ is defined as running on a node whose
+ value of the label with key topologyKey
+ matches that of any node on which any
+ of the selected pods is running. Empty
+ topologyKey is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
+ description: weight associated with matching
+ the corresponding podAffinityTerm, in the
+ range 1-100.
format: int32
type: integer
required:
@@ -1742,26 +2748,59 @@
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
+ description: If the anti-affinity requirements specified
+ by this field are not met at scheduling time, the
+ pod will not be scheduled onto the node. If the
+ anti-affinity requirements specified by this field
+ cease to be met at some point during pod execution
+ (e.g. due to a pod label update), the system may
+ or may not try to eventually evict the pod from
+ its node. When there are multiple elements, the
+ lists of nodes corresponding to each podAffinityTerm
+ are intersected, i.e. all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
+ description: Defines a set of pods (namely those
+ matching the labelSelector relative to the given
+ namespace(s)) that this pod should be co-located
+ (affinity) or not co-located (anti-affinity) with,
+ where co-located is defined as running on a node
+ whose value of the label with key <topologyKey>
+ matches that of any node on which a pod of the
+ set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of resources,
+ in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The requirements
+ are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label key
+ that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a
+ key's relationship to a set of values.
+ Valid operators are In, NotIn, Exists
+ and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -1773,16 +2812,30 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which namespaces
+ the labelSelector applies to (matches against);
+ null or empty list means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity)
+ or not co-located (anti-affinity) with the
+ pods matching the labelSelector in the specified
+ namespaces, where co-located is defined as
+ running on a node whose value of the label
+ with key topologyKey matches that of any node
+ on which any of the selected pods is running.
+ Empty topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -1796,7 +2849,9 @@
description: Annotations to be added for pods.
type: object
defaultInitContainerResources:
- description: DefaultInitContainerResources are the resource requirements for the default init container(s) created by the Solr Operator, if any are created.
+ description: DefaultInitContainerResources are the resource
+ requirements for the default init container(s) created by
+ the Solr Operator, if any are created.
properties:
limits:
additionalProperties:
@@ -1805,7 +2860,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount of compute
+ resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -1814,22 +2870,38 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
envVars:
- description: Additional environment variables to pass to the default container.
+ description: Additional environment variables to pass to the
+ default container.
items:
- description: EnvVar represents an environment variable present in a Container.
+ description: EnvVar represents an environment variable present
+ in a Container.
properties:
name:
- description: Name of the environment variable. Must be a C_IDENTIFIER.
+ description: Name of the environment variable. Must
+ be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME) are expanded
+ using the previous 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. The $(VAR_NAME)
+ syntax can be escaped with a double $$, ie: $$(VAR_NAME).
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Defaults to
+ "".'
type: string
valueFrom:
- description: Source for the environment variable's value. Cannot be used if value is not empty.
+ description: Source for the environment variable's value.
+ Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -1838,37 +2910,53 @@
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key must be defined
+ description: Specify whether the ConfigMap or
+ its key must be defined
type: boolean
required:
- key
type: object
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.'
+ 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.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema the FieldPath
+ is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to select in
+ the specified API version.
type: string
required:
- fieldPath
type: object
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.'
+ 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.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required for volumes,
+ optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output format of
+ the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -1878,16 +2966,22 @@
- resource
type: object
secretKeyRef:
- description: Selects a key of a secret in the pod's namespace
+ description: Selects a key of a secret in the pod's
+ namespace
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select
+ from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its
+ key must be defined
type: boolean
required:
- key
@@ -1898,43 +2992,80 @@
type: object
type: array
imagePullSecrets:
- description: ImagePullSecrets to apply to the pod. These are for init/sidecarContainers in addition to the imagePullSecret defined for the solr image.
+ description: ImagePullSecrets to apply to the pod. These are
+ for init/sidecarContainers in addition to the imagePullSecret
+ defined for the solr image.
items:
- description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
+ description: LocalObjectReference contains enough information
+ to let you locate the referenced object inside the same
+ namespace.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
type: array
initContainers:
- description: Additional init containers to run in the pod. These will run along with the init container that sets up the "solr.xml".
+ description: Additional init containers to run in the pod.
+ These will run along with the init container that sets up
+ the "solr.xml".
items:
- description: A single application container that you want to run within a pod.
+ description: A single application container that you want
+ to run within a pod.
properties:
args:
- description: 'Arguments to the entrypoint. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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'
+ description: 'Arguments to the entrypoint. The docker
+ 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. The
+ $(VAR_NAME) syntax can be escaped with a double $$,
+ ie: $$(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'
items:
type: string
type: array
command:
- description: 'Entrypoint array. Not executed within a shell. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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'
+ description: 'Entrypoint array. Not executed within
+ a shell. The docker 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. The $(VAR_NAME) syntax
+ can be escaped with a double $$, ie: $$(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'
items:
type: string
type: array
env:
- description: List of environment variables to set in the container. Cannot be updated.
+ description: List of environment variables to set in
+ the container. Cannot be updated.
items:
- description: EnvVar represents an environment variable present in a Container.
+ description: EnvVar represents an environment variable
+ present in a Container.
properties:
name:
- description: Name of the environment variable. Must be a C_IDENTIFIER.
+ description: Name of the environment variable.
+ Must be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previous 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.
+ The $(VAR_NAME) syntax can be escaped with a
+ double $$, ie: $$(VAR_NAME). Escaped references
+ will never be expanded, regardless of whether
+ the variable exists or not. Defaults to "".'
type: string
valueFrom:
- description: Source for the environment variable's value. Cannot be used if value is not empty.
+ description: Source for the environment variable's
+ value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -1943,37 +3074,55 @@
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key must be defined
+ description: Specify whether the ConfigMap
+ or its key must be defined
type: boolean
required:
- key
type: object
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.'
+ 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.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema the
+ FieldPath is written in terms of, defaults
+ to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to select
+ in the specified API version.
type: string
required:
- fieldPath
type: object
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.'
+ 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.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required
+ for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output format
+ of the exposed resources, defaults to
+ "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -1983,16 +3132,23 @@
- resource
type: object
secretKeyRef:
- description: Selects a key of a secret in the pod's namespace
+ description: Selects a key of a secret in
+ the pod's namespace
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to
+ select from. Must be a valid secret
+ key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret
+ or its key must be defined
type: boolean
required:
- key
@@ -2003,66 +3159,112 @@
type: object
type: array
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.
+ 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.
items:
- description: EnvFromSource represents the source of a set of ConfigMaps
+ description: EnvFromSource represents the source of
+ a set of ConfigMaps
properties:
configMapRef:
description: The ConfigMap to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap must be defined
+ description: Specify whether the ConfigMap
+ must be defined
type: boolean
type: object
prefix:
- description: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ description: An optional identifier to prepend
+ to each key in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
description: The Secret to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret must be defined
+ description: Specify whether the Secret must
+ be defined
type: boolean
type: object
type: object
type: array
image:
- description: 'Docker 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.'
+ description: 'Docker 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.'
type: string
imagePullPolicy:
- description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
+ description: 'Image pull policy. One of Always, Never,
+ IfNotPresent. Defaults to Always if :latest tag is
+ specified, or IfNotPresent otherwise. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
+ description: Actions that the management system should
+ take in response to container lifecycle events. Cannot
+ be updated.
properties:
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following
+ should be specified. Exec specifies the action
+ to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
+ "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the
+ request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2076,58 +3278,99 @@
type: object
type: array
path:
- description: Path to access on the HTTP server.
+ description: Path to access on the HTTP
+ server.
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action
+ involving a TCP port. TCP hooks not yet supported
+ TODO: implement a realistic TCP lifecycle
+ hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
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 reason for termination is passed to the handler. The Pod''s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period. 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'
+ 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 reason for termination is passed
+ to the handler. The Pod''s termination grace period
+ countdown begins before the PreStop hooked is
+ executed. Regardless of the outcome of the handler,
+ the container will eventually terminate within
+ the Pod''s termination grace period. 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following
+ should be specified. Exec specifies the action
+ to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
+ "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the
+ request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2141,31 +3384,43 @@
type: object
type: array
path:
- description: Path to access on the HTTP server.
+ description: Path to access on the HTTP
+ server.
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action
+ involving a TCP port. TCP hooks not yet supported
+ TODO: implement a realistic TCP lifecycle
+ hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
@@ -2173,31 +3428,49 @@
type: object
type: object
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2217,71 +3490,109 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
name:
- description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
+ description: Name of the container specified as a DNS_LABEL.
+ Each container in a pod must have a unique name (DNS_LABEL).
+ Cannot be updated.
type: string
ports:
- description: List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. Cannot be updated.
+ description: List of ports to expose from the container.
+ Exposing a port here gives the system additional information
+ about the network connections a container uses, but
+ is primarily informational. 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. Cannot be updated.
items:
- description: ContainerPort represents a network port in a single container.
+ description: ContainerPort represents a network port
+ in a single container.
properties:
containerPort:
- description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's
+ IP address. This must be a valid port number,
+ 0 < x < 65536.
format: int32
type: integer
hostIP:
- description: What host IP to bind the external port to.
+ description: What host IP to bind the external
+ port to.
type: string
hostPort:
- description: 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 do not need this.
+ description: 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
+ do not need this.
format: int32
type: integer
name:
- description: 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.
+ description: 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.
type: string
protocol:
default: TCP
- description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP,
+ or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -2292,31 +3603,49 @@
- protocol
x-kubernetes-list-type: map
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2336,48 +3665,66 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
resources:
- description: 'Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Compute Resources required by this container.
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
properties:
limits:
additionalProperties:
@@ -2386,7 +3733,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -2395,119 +3743,221 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
securityContext:
- description: 'Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
+ description: 'Security options the pod should run with.
+ More info: https://kubernetes.io/docs/concepts/policy/security-context/
+ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: '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'
+ description: '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'
type: boolean
capabilities:
- description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
+ description: The capabilities to add/drop when running
+ containers. Defaults to the default set of capabilities
+ granted by the container runtime.
properties:
add:
description: Added capabilities
items:
- description: Capability represent POSIX capabilities type
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
drop:
description: Removed capabilities
items:
- description: Capability represent POSIX capabilities type
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
type: object
privileged:
- description: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
+ description: Run container in privileged mode. Processes
+ in privileged containers are essentially equivalent
+ to root on the host. Defaults to false.
type: boolean
procMount:
- description: 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.
+ description: 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.
type: string
readOnlyRootFilesystem:
- description: Whether this container has a read-only root filesystem. Default is false.
+ description: Whether this container has a read-only
+ root filesystem. Default is false.
type: boolean
runAsGroup:
- description: 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.
+ description: 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.
format: int64
type: integer
runAsNonRoot:
- description: 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.
+ description: 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.
type: boolean
runAsUser:
- description: 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.
+ description: 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.
format: int64
type: integer
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.
+ 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.
properties:
level:
- description: Level is SELinux level label that applies to the container.
+ description: Level is SELinux level label that
+ applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies to the container.
+ description: Role is a SELinux role label that
+ applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies to the container.
+ description: Type is a SELinux type label that
+ applies to the container.
type: string
user:
- description: User is a SELinux user label that applies to the container.
+ description: User is a SELinux user label that
+ applies to the container.
type: string
type: object
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.
+ 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.
properties:
localhostProfile:
- description: 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 only be set if type is "Localhost".
+ description: 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 only be set if type is "Localhost".
type: string
type:
- description: "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."
+ description: "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."
type: string
required:
- type
type: object
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.
+ 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.
properties:
gmsaCredentialSpec:
- description: 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.
+ description: 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.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name
+ of the GMSA credential spec to use.
type: string
runAsUserName:
- description: 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.
+ description: 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.
type: string
type: object
type: object
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2527,71 +3977,124 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
stdin:
- description: 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.
+ description: 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.
type: boolean
stdinOnce:
- description: 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
+ description: 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
type: boolean
terminationMessagePath:
- description: 'Optional: Path at which the file to which the container''s termination message will be written is mounted into the container''s filesystem. 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.'
+ description: 'Optional: Path at which the file to which
+ the container''s termination message will be written
+ is mounted into the container''s filesystem. 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.'
type: string
terminationMessagePolicy:
- description: 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.
+ description: 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.
type: string
tty:
- description: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be true.
+ Default is false.
type: boolean
volumeDevices:
- description: volumeDevices is the list of block devices to be used by the container.
+ description: volumeDevices is the list of block devices
+ to be used by the container.
items:
- description: volumeDevice describes a mapping of a raw block device within a container.
+ description: volumeDevice describes a mapping of a
+ raw block device within a container.
properties:
devicePath:
- description: devicePath is the path inside of the container that the device will be mapped to.
+ description: devicePath is the path inside of
+ the container that the device will be mapped
+ to.
type: string
name:
- description: name must match the name of a persistentVolumeClaim in the pod
+ description: name must match the name of a persistentVolumeClaim
+ in the pod
type: string
required:
- devicePath
@@ -2599,27 +4102,44 @@
type: object
type: array
volumeMounts:
- description: Pod volumes to mount into the container's filesystem. Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
- description: VolumeMount describes a mounting of a Volume within a container.
+ description: VolumeMount describes a mounting of a
+ Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume should be mounted. Must not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: 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.
+ description: 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.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which
+ the container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: 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.
+ description: 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.
type: string
required:
- mountPath
@@ -2627,7 +4147,10 @@
type: object
type: array
workingDir:
- description: 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.
+ description: 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.
type: string
required:
- name
@@ -2642,27 +4165,45 @@
description: Lifecycle for the main container
properties:
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request to
+ perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2682,52 +4223,85 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the
+ host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to,
+ defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
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 reason for termination is passed to the handler. The Pod''s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period. 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'
+ 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 reason for termination
+ is passed to the handler. The Pod''s termination grace
+ period countdown begins before the PreStop hooked is
+ executed. Regardless of the outcome of the handler,
+ the container will eventually terminate within the Pod''s
+ termination grace period. 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request to
+ perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2747,25 +4321,33 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the
+ host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to,
+ defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
@@ -2776,28 +4358,42 @@
description: Liveness probe parameters
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe
+ to be considered failed after having succeeded. Defaults
+ to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults to
+ the pod IP. You probably want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2817,43 +4413,59 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host.
+ Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe.
+ Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults
+ to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
@@ -2863,64 +4475,122 @@
description: Node Selector to be added for the StatefulSet.
type: object
podSecurityContext:
- description: PodSecurityContext is the security context for the pod.
+ description: PodSecurityContext is the security context for
+ the pod.
properties:
fsGroup:
- description: "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume."
+ description: "A special supplemental group that applies
+ to all containers in a pod. Some volume types allow
+ the Kubelet to change the ownership of that volume to
+ be owned by the pod: \n 1. The owning GID will be the
+ FSGroup 2. The setgid bit is set (new files created
+ in the volume will be owned by FSGroup) 3. The permission
+ bits are OR'd with rw-rw---- \n If unset, the Kubelet
+ will not modify the ownership and permissions of any
+ volume."
format: int64
type: integer
fsGroupChangePolicy:
- description: 'fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.'
+ description: 'fsGroupChangePolicy defines behavior of
+ changing ownership and permission of the volume before
+ being exposed inside Pod. This field will only apply
+ to volume types which support fsGroup based ownership(and
+ permissions). It will have no effect on ephemeral volume
+ types such as: secret, configmaps and emptydir. Valid
+ values are "OnRootMismatch" and "Always". If not specified,
+ "Always" is used.'
type: string
runAsGroup:
- description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The GID to run the entrypoint of the container
+ process. Uses runtime default if unset. May also be
+ set in SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container.
format: int64
type: integer
runAsNonRoot:
- description: 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 SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: 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 SecurityContext. If set
+ in both SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The UID to run the entrypoint of the container
+ process. Defaults to user specified in image metadata
+ if unspecified. May also be set in SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence
+ for that container.
format: int64
type: integer
seLinuxOptions:
- description: The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The SELinux context to be applied to all
+ containers. If unspecified, the container runtime will
+ allocate a random SELinux context for each container. May
+ also be set in SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container.
properties:
level:
- description: Level is SELinux level label that applies to the container.
+ description: Level is SELinux level label that applies
+ to the container.
type: string
role:
- description: Role is a SELinux role label that applies to the container.
+ description: Role is a SELinux role label that applies
+ to the container.
type: string
type:
- description: Type is a SELinux type label that applies to the container.
+ description: Type is a SELinux type label that applies
+ to the container.
type: string
user:
- description: User is a SELinux user label that applies to the container.
+ description: User is a SELinux user label that applies
+ to the container.
type: string
type: object
seccompProfile:
- description: The seccomp options to use by the containers in this pod.
+ description: The seccomp options to use by the containers
+ in this pod.
properties:
localhostProfile:
- description: 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 only be set if type is "Localhost".
+ description: 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 only be
+ set if type is "Localhost".
type: string
type:
- description: "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."
+ description: "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."
type: string
required:
- type
type: object
supplementalGroups:
- description: A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.
+ description: A list of groups applied to the first process
+ run in each container, in addition to the container's
+ primary GID. If unspecified, no groups will be added
+ to any container.
items:
format: int64
type: integer
type: array
sysctls:
- description: Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.
+ description: Sysctls hold a list of namespaced sysctls
+ used for the pod. Pods with unsupported sysctls (by
+ the container runtime) might fail to launch.
items:
- description: Sysctl defines a kernel parameter to be set
+ description: Sysctl defines a kernel parameter to be
+ set
properties:
name:
description: Name of a property to set
@@ -2934,16 +4604,29 @@
type: object
type: array
windowsOptions:
- description: The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The Windows specific settings applied to
+ all containers. If unspecified, the options within a
+ container's SecurityContext will be used. If set in
+ both SecurityContext and PodSecurityContext, the value
+ specified in SecurityContext takes precedence.
properties:
gmsaCredentialSpec:
- description: 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.
+ description: 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.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name of
+ the GMSA credential spec to use.
type: string
runAsUserName:
- description: 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.
+ description: 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.
type: string
type: object
type: object
@@ -2954,28 +4637,42 @@
description: Readiness probe parameters
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe
+ to be considered failed after having succeeded. Defaults
+ to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults to
+ the pod IP. You probably want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -2995,48 +4692,65 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host.
+ Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe.
+ Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults
+ to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
resources:
- description: Resources is the resource requirements for the default container.
+ description: Resources is the resource requirements for the
+ default container.
properties:
limits:
additionalProperties:
@@ -3045,7 +4759,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount of compute
+ resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -3054,40 +4769,75 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
serviceAccountName:
description: Optional Service Account to run the pod under.
type: string
sidecarContainers:
- description: Sidecar containers to run in the pod. These are in addition to the Solr Container
+ description: Sidecar containers to run in the pod. These are
+ in addition to the Solr Container
items:
- description: A single application container that you want to run within a pod.
+ description: A single application container that you want
+ to run within a pod.
properties:
args:
- description: 'Arguments to the entrypoint. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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'
+ description: 'Arguments to the entrypoint. The docker
+ 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. The
+ $(VAR_NAME) syntax can be escaped with a double $$,
+ ie: $$(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'
items:
type: string
type: array
command:
- description: 'Entrypoint array. Not executed within a shell. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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'
+ description: 'Entrypoint array. Not executed within
+ a shell. The docker 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. The $(VAR_NAME) syntax
+ can be escaped with a double $$, ie: $$(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'
items:
type: string
type: array
env:
- description: List of environment variables to set in the container. Cannot be updated.
+ description: List of environment variables to set in
+ the container. Cannot be updated.
items:
- description: EnvVar represents an environment variable present in a Container.
+ description: EnvVar represents an environment variable
+ present in a Container.
properties:
name:
- description: Name of the environment variable. Must be a C_IDENTIFIER.
+ description: Name of the environment variable.
+ Must be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previous 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.
+ The $(VAR_NAME) syntax can be escaped with a
+ double $$, ie: $$(VAR_NAME). Escaped references
+ will never be expanded, regardless of whether
+ the variable exists or not. Defaults to "".'
type: string
valueFrom:
- description: Source for the environment variable's value. Cannot be used if value is not empty.
+ description: Source for the environment variable's
+ value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -3096,37 +4846,55 @@
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key must be defined
+ description: Specify whether the ConfigMap
+ or its key must be defined
type: boolean
required:
- key
type: object
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.'
+ 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.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema the
+ FieldPath is written in terms of, defaults
+ to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to select
+ in the specified API version.
type: string
required:
- fieldPath
type: object
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.'
+ 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.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required
+ for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output format
+ of the exposed resources, defaults to
+ "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -3136,16 +4904,23 @@
- resource
type: object
secretKeyRef:
- description: Selects a key of a secret in the pod's namespace
+ description: Selects a key of a secret in
+ the pod's namespace
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to
+ select from. Must be a valid secret
+ key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret
+ or its key must be defined
type: boolean
required:
- key
@@ -3156,66 +4931,112 @@
type: object
type: array
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.
+ 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.
items:
- description: EnvFromSource represents the source of a set of ConfigMaps
+ description: EnvFromSource represents the source of
+ a set of ConfigMaps
properties:
configMapRef:
description: The ConfigMap to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap must be defined
+ description: Specify whether the ConfigMap
+ must be defined
type: boolean
type: object
prefix:
- description: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ description: An optional identifier to prepend
+ to each key in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
description: The Secret to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret must be defined
+ description: Specify whether the Secret must
+ be defined
type: boolean
type: object
type: object
type: array
image:
- description: 'Docker 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.'
+ description: 'Docker 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.'
type: string
imagePullPolicy:
- description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
+ description: 'Image pull policy. One of Always, Never,
+ IfNotPresent. Defaults to Always if :latest tag is
+ specified, or IfNotPresent otherwise. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
+ description: Actions that the management system should
+ take in response to container lifecycle events. Cannot
+ be updated.
properties:
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following
+ should be specified. Exec specifies the action
+ to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
+ "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the
+ request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3229,58 +5050,99 @@
type: object
type: array
path:
- description: Path to access on the HTTP server.
+ description: Path to access on the HTTP
+ server.
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action
+ involving a TCP port. TCP hooks not yet supported
+ TODO: implement a realistic TCP lifecycle
+ hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
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 reason for termination is passed to the handler. The Pod''s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period. 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'
+ 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 reason for termination is passed
+ to the handler. The Pod''s termination grace period
+ countdown begins before the PreStop hooked is
+ executed. Regardless of the outcome of the handler,
+ the container will eventually terminate within
+ the Pod''s termination grace period. 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following
+ should be specified. Exec specifies the action
+ to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
+ "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the
+ request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3294,31 +5156,43 @@
type: object
type: array
path:
- description: Path to access on the HTTP server.
+ description: Path to access on the HTTP
+ server.
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action
+ involving a TCP port. TCP hooks not yet supported
+ TODO: implement a realistic TCP lifecycle
+ hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
@@ -3326,31 +5200,49 @@
type: object
type: object
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3370,71 +5262,109 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
name:
- description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
+ description: Name of the container specified as a DNS_LABEL.
+ Each container in a pod must have a unique name (DNS_LABEL).
+ Cannot be updated.
type: string
ports:
- description: List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. Cannot be updated.
+ description: List of ports to expose from the container.
+ Exposing a port here gives the system additional information
+ about the network connections a container uses, but
+ is primarily informational. 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. Cannot be updated.
items:
- description: ContainerPort represents a network port in a single container.
+ description: ContainerPort represents a network port
+ in a single container.
properties:
containerPort:
- description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's
+ IP address. This must be a valid port number,
+ 0 < x < 65536.
format: int32
type: integer
hostIP:
- description: What host IP to bind the external port to.
+ description: What host IP to bind the external
+ port to.
type: string
hostPort:
- description: 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 do not need this.
+ description: 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
+ do not need this.
format: int32
type: integer
name:
- description: 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.
+ description: 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.
type: string
protocol:
default: TCP
- description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP,
+ or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -3445,31 +5375,49 @@
- protocol
x-kubernetes-list-type: map
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3489,48 +5437,66 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
resources:
- description: 'Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Compute Resources required by this container.
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
properties:
limits:
additionalProperties:
@@ -3539,7 +5505,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -3548,119 +5515,221 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
securityContext:
- description: 'Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
+ description: 'Security options the pod should run with.
+ More info: https://kubernetes.io/docs/concepts/policy/security-context/
+ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: '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'
+ description: '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'
type: boolean
capabilities:
- description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
+ description: The capabilities to add/drop when running
+ containers. Defaults to the default set of capabilities
+ granted by the container runtime.
properties:
add:
description: Added capabilities
items:
- description: Capability represent POSIX capabilities type
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
drop:
description: Removed capabilities
items:
- description: Capability represent POSIX capabilities type
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
type: object
privileged:
- description: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
+ description: Run container in privileged mode. Processes
+ in privileged containers are essentially equivalent
+ to root on the host. Defaults to false.
type: boolean
procMount:
- description: 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.
+ description: 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.
type: string
readOnlyRootFilesystem:
- description: Whether this container has a read-only root filesystem. Default is false.
+ description: Whether this container has a read-only
+ root filesystem. Default is false.
type: boolean
runAsGroup:
- description: 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.
+ description: 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.
format: int64
type: integer
runAsNonRoot:
- description: 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.
+ description: 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.
type: boolean
runAsUser:
- description: 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.
+ description: 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.
format: int64
type: integer
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.
+ 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.
properties:
level:
- description: Level is SELinux level label that applies to the container.
+ description: Level is SELinux level label that
+ applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies to the container.
+ description: Role is a SELinux role label that
+ applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies to the container.
+ description: Type is a SELinux type label that
+ applies to the container.
type: string
user:
- description: User is a SELinux user label that applies to the container.
+ description: User is a SELinux user label that
+ applies to the container.
type: string
type: object
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.
+ 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.
properties:
localhostProfile:
- description: 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 only be set if type is "Localhost".
+ description: 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 only be set if type is "Localhost".
type: string
type:
- description: "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."
+ description: "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."
type: string
required:
- type
type: object
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.
+ 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.
properties:
gmsaCredentialSpec:
- description: 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.
+ description: 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.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name
+ of the GMSA credential spec to use.
type: string
runAsUserName:
- description: 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.
+ description: 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.
type: string
type: object
type: object
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3680,71 +5749,124 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
stdin:
- description: 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.
+ description: 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.
type: boolean
stdinOnce:
- description: 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
+ description: 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
type: boolean
terminationMessagePath:
- description: 'Optional: Path at which the file to which the container''s termination message will be written is mounted into the container''s filesystem. 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.'
+ description: 'Optional: Path at which the file to which
+ the container''s termination message will be written
+ is mounted into the container''s filesystem. 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.'
type: string
terminationMessagePolicy:
- description: 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.
+ description: 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.
type: string
tty:
- description: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be true.
+ Default is false.
type: boolean
volumeDevices:
- description: volumeDevices is the list of block devices to be used by the container.
+ description: volumeDevices is the list of block devices
+ to be used by the container.
items:
- description: volumeDevice describes a mapping of a raw block device within a container.
+ description: volumeDevice describes a mapping of a
+ raw block device within a container.
properties:
devicePath:
- description: devicePath is the path inside of the container that the device will be mapped to.
+ description: devicePath is the path inside of
+ the container that the device will be mapped
+ to.
type: string
name:
- description: name must match the name of a persistentVolumeClaim in the pod
+ description: name must match the name of a persistentVolumeClaim
+ in the pod
type: string
required:
- devicePath
@@ -3752,27 +5874,44 @@
type: object
type: array
volumeMounts:
- description: Pod volumes to mount into the container's filesystem. Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
- description: VolumeMount describes a mounting of a Volume within a container.
+ description: VolumeMount describes a mounting of a
+ Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume should be mounted. Must not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: 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.
+ description: 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.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which
+ the container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: 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.
+ description: 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.
type: string
required:
- mountPath
@@ -3780,7 +5919,10 @@
type: object
type: array
workingDir:
- description: 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.
+ description: 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.
type: string
required:
- name
@@ -3790,28 +5932,42 @@
description: Startup probe parameters
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe
+ to be considered failed after having succeeded. Defaults
+ to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults to
+ the pod IP. You probably want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -3831,95 +5987,149 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host.
+ Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe.
+ Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults
+ to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs to terminate gracefully.
+ description: Optional duration in seconds the pod needs to
+ terminate gracefully.
format: int64
minimum: 10
type: integer
tolerations:
description: Tolerations to be added for the StatefulSet.
items:
- description: The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
+ description: The pod this Toleration is attached to tolerates
+ any taint that matches the triple <key,value,effect> using
+ the matching operator <operator>.
properties:
effect:
- description: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
+ description: Effect indicates the taint effect to match.
+ Empty means match all taint effects. When specified,
+ allowed values are NoSchedule, PreferNoSchedule and
+ NoExecute.
type: string
key:
- description: Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
+ description: Key is the taint key that the toleration
+ applies to. Empty means match all taint keys. If the
+ key is empty, operator must be Exists; this combination
+ means to match all values and all keys.
type: string
operator:
- description: Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
+ description: Operator represents a key's relationship
+ to the value. Valid operators are Exists and Equal.
+ Defaults to Equal. Exists is equivalent to wildcard
+ for value, so that a pod can tolerate all taints of
+ a particular category.
type: string
tolerationSeconds:
- description: TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
+ description: TolerationSeconds represents the period
+ of time the toleration (which must be of effect NoExecute,
+ otherwise this field is ignored) tolerates the taint.
+ By default, it is not set, which means tolerate the
+ taint forever (do not evict). Zero and negative values
+ will be treated as 0 (evict immediately) by the system.
format: int64
type: integer
value:
- description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
+ description: Value is the taint value the toleration
+ matches to. If the operator is Exists, the value should
+ be empty, otherwise just a regular string.
type: string
type: object
type: array
topologySpreadConstraints:
- description: "Optional PodSpreadTopologyConstraints to use when scheduling pods. More information here: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ \n Note: There is no need to provide a \"labelSelector\", as the operator will inject the labels for you if not provided."
+ description: "Optional PodSpreadTopologyConstraints to use
+ when scheduling pods. More information here: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
+ \n Note: There is no need to provide a \"labelSelector\",
+ as the operator will inject the labels for you if not provided."
items:
- description: TopologySpreadConstraint specifies how to spread matching pods among the given topology.
+ description: TopologySpreadConstraint specifies how to spread
+ matching pods among the given topology.
properties:
labelSelector:
- description: LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
+ description: LabelSelector is used to find matching
+ pods. Pods that match this label selector are counted
+ to determine the number of pods in their corresponding
+ topology domain.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label
+ selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement is a
+ selector that contains values, a key, and an
+ operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label key that the
+ selector applies to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship
+ to a set of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -3931,18 +6141,59 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
maxSkew:
- description: 'MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It''s a required field. Default value is 1 and 0 is not allowed.'
+ description: 'MaxSkew describes the degree to which
+ pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`,
+ it is the maximum permitted difference between the
+ number of matching pods in the target topology and
+ the global minimum. For example, in a 3-zone cluster,
+ MaxSkew is set to 1, and pods with the same labelSelector
+ spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | |
+ - if MaxSkew is 1, incoming pod can only be scheduled
+ to zone3 to become 1/1/1; scheduling it onto zone1(zone2)
+ would make the ActualSkew(2-0) on zone1(zone2) violate
+ MaxSkew(1). - if MaxSkew is 2, incoming pod can be
+ scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`,
+ it is used to give higher precedence to topologies
+ that satisfy it. It''s a required field. Default value
+ is 1 and 0 is not allowed.'
format: int32
type: integer
topologyKey:
- description: TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. It's a required field.
+ description: TopologyKey is the key of node labels.
+ Nodes that have a label with this key and identical
+ values are considered to be in the same topology.
+ We consider each <key, value> as a "bucket", and try
+ to put balanced number of pods into each bucket. It's
+ a required field.
type: string
whenUnsatisfiable:
- description: 'WhenUnsatisfiable indicates how to deal with a pod if it doesn''t satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won''t make it *more* imbalanced. It''s a required field.'
+ description: 'WhenUnsatisfiable indicates how to deal
+ with a pod if it doesn''t satisfy the spread constraint.
+ - DoNotSchedule (default) tells the scheduler not
+ to schedule it. - ScheduleAnyway tells the scheduler
+ to schedule the pod in any location, but giving
+ higher precedence to topologies that would help reduce
+ the skew. A constraint is considered "Unsatisfiable"
+ for an incoming pod if and only if every possible
+ node assigment for that pod would violate "MaxSkew"
+ on some topology. For example, in a 3-zone cluster,
+ MaxSkew is set to 1, and pods with the same labelSelector
+ spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P
+ | P | P | If WhenUnsatisfiable is set to DoNotSchedule,
+ incoming pod can only be scheduled to zone2(zone3)
+ to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3)
+ satisfies MaxSkew(1). In other words, the cluster
+ can still be imbalanced, but scheduler won''t make
+ it *more* imbalanced. It''s a required field.'
type: string
required:
- maxSkew
@@ -3955,30 +6206,49 @@
- whenUnsatisfiable
x-kubernetes-list-type: map
volumes:
- description: Additional non-data volumes to load into the default container.
+ description: Additional non-data volumes to load into the
+ default container.
items:
- description: AdditionalVolume provides information on additional volumes that should be loaded into pods
+ description: AdditionalVolume provides information on additional
+ volumes that should be loaded into pods
properties:
defaultContainerMount:
- description: DefaultContainerMount defines how to mount this volume into the default container. If this volume is to be used only with sidecar or non-default init containers, then this option is not necessary.
+ description: DefaultContainerMount defines how to mount
+ this volume into the default container. If this volume
+ is to be used only with sidecar or non-default init
+ containers, then this option is not necessary.
properties:
mountPath:
- description: Path within the container at which the volume should be mounted. Must not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: 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.
+ description: 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.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which the
+ container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: 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.
+ description: 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.
type: string
required:
- mountPath
@@ -3988,60 +6258,100 @@
description: Name of the volume
type: string
source:
- description: Source is the source of the Volume to be loaded into the solrCloud Pod
+ description: Source is the source of the Volume to be
+ loaded into the solrCloud Pod
properties:
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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 TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume
+ that you want to mount. Tip: Ensure that the
+ filesystem 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
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: '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).'
+ description: '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).'
format: int32
type: integer
readOnly:
- description: 'Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'Specify "true" to force and set
+ the ReadOnly property in VolumeMounts to "true".
+ If omitted, the default is "false". More info:
+ https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: boolean
volumeID:
- description: 'Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'Unique ID of the persistent disk
+ resource in AWS (Amazon EBS volume). More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: string
required:
- volumeID
type: object
azureDisk:
- description: AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+ description: AzureDisk represents an Azure Data
+ Disk mount on the host and bind mount to the pod.
properties:
cachingMode:
- description: 'Host Caching mode: None, Read Only, Read Write.'
+ description: 'Host Caching mode: None, Read
+ Only, Read Write.'
type: string
diskName:
- description: The Name of the data disk in the blob storage
+ description: The Name of the data disk in the
+ blob storage
type: string
diskURI:
- description: The URI the data disk in the blob storage
+ description: The URI the data disk in the blob
+ storage
type: string
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
kind:
- description: 'Expected values 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'
+ description: 'Expected values 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'
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
required:
- diskName
- diskURI
type: object
azureFile:
- description: AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
+ description: AzureFile represents an Azure File
+ Service mount on the host and bind mount to the
+ pod.
properties:
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretName:
- description: the name of secret that contains Azure Storage Account Name and Key
+ description: the name of secret that contains
+ Azure Storage Account Name and Key
type: string
shareName:
description: Share Name
@@ -4051,78 +6361,142 @@
- shareName
type: object
cephfs:
- description: CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
+ description: CephFS represents a Ceph FS mount on
+ the host that shares a pod's lifetime
properties:
monitors:
- description: 'Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'Required: Monitors is a collection
+ of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
items:
type: string
type: array
path:
- description: 'Optional: Used as the mounted root, rather than the full Ceph tree, default is /'
+ description: 'Optional: Used as the mounted
+ root, rather than the full Ceph tree, default
+ is /'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
secretFile:
- description: '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'
+ description: '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'
type: string
secretRef:
- description: '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'
+ description: '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'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
user:
- description: 'Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'Optional: User is the rados user
+ name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
required:
- monitors
type: object
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'
+ description: 'Cinder represents a cinder volume
+ attached and mounted on kubelets host machine.
+ More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
properties:
fsType:
- description: 'Filesystem type to mount. Must be a filesystem 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'
+ description: 'Filesystem type to mount. Must
+ be a filesystem 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'
type: string
readOnly:
- description: 'Optional: 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'
+ description: 'Optional: 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'
type: boolean
secretRef:
- description: 'Optional: points to a secret object containing parameters used to connect to OpenStack.'
+ description: 'Optional: points to a secret object
+ containing parameters used to connect to OpenStack.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
volumeID:
- description: 'volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'volume id used to identify the
+ volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
required:
- volumeID
type: object
configMap:
- description: ConfigMap represents a configMap that should populate this volume
+ description: ConfigMap represents a configMap that
+ should populate this volume
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: 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 '..'.
+ description: 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 '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to a path within
+ a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -4130,85 +6504,156 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its keys must be defined
+ description: Specify whether the ConfigMap or
+ its keys must be defined
type: boolean
type: object
csi:
- description: CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
+ description: CSI (Container Storage Interface) represents
+ ephemeral storage that is handled by certain external
+ CSI drivers (Beta feature).
properties:
driver:
- description: Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
+ description: Driver is the name of the CSI driver
+ that handles this volume. Consult with your
+ admin for the correct name as registered in
+ the cluster.
type: string
fsType:
- description: Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
+ description: Filesystem type to mount. Ex. "ext4",
+ "xfs", "ntfs". If not provided, the empty
+ value is passed to the associated CSI driver
+ which will determine the default filesystem
+ to apply.
type: string
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.
+ 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.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
readOnly:
- description: Specifies a read-only configuration for the volume. Defaults to false (read/write).
+ description: Specifies a read-only configuration
+ for the volume. Defaults to false (read/write).
type: boolean
volumeAttributes:
additionalProperties:
type: string
- description: VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
+ description: VolumeAttributes stores driver-specific
+ properties that are passed to the CSI driver.
+ Consult your driver's documentation for supported
+ values.
type: object
required:
- driver
type: object
downwardAPI:
- description: DownwardAPI represents downward API about the pod that should populate this volume
+ description: DownwardAPI represents downward API
+ about the pod that should populate this volume
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: Items is a list of downward API volume file
+ description: Items is a list of downward API
+ volume file
items:
- description: DownwardAPIVolumeFile represents information to create the file containing the pod field
+ description: DownwardAPIVolumeFile represents
+ information to create the file containing
+ the pod field
properties:
fieldRef:
- description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
+ description: 'Required: Selects a field
+ of the pod: only annotations, labels,
+ name and namespace are supported.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema
+ the FieldPath is written in terms
+ of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to
+ select in the specified API version.
type: string
required:
- fieldPath
type: object
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative path name 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 ''..'''
+ description: 'Required: Path is the relative
+ path name 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 ''..'''
type: string
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.'
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ requests.cpu and requests.memory) are
+ currently supported.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required
+ for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output
+ format of the exposed resources,
+ defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
- description: 'Required: resource to select'
+ description: 'Required: resource to
+ select'
type: string
required:
- resource
@@ -4219,57 +6664,147 @@
type: array
type: object
emptyDir:
- description: 'EmptyDir represents a temporary directory that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
+ description: 'EmptyDir represents a temporary directory
+ that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
properties:
medium:
- description: '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'
+ description: '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'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
+ description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: "Ephemeral represents a volume that is handled by a cluster storage driver (Alpha feature). 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."
+ description: "Ephemeral represents a volume that
+ is handled by a cluster storage driver (Alpha
+ feature). 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."
properties:
readOnly:
- description: Specifies a read-only configuration for the volume. Defaults to false (read/write).
+ description: Specifies a read-only configuration
+ for the volume. Defaults to false (read/write).
type: boolean
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). \n 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. \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."
+ 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).
+ \n 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. \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."
properties:
metadata:
- description: 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.
+ description: 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.
type: object
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.
+ 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.
properties:
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'
+ description: 'AccessModes contains the
+ desired access modes the volume should
+ have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. 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.'
+ description: 'This field can be used
+ to specify either: * An existing VolumeSnapshot
+ object (snapshot.storage.k8s.io/VolumeSnapshot)
+ * An existing PVC (PersistentVolumeClaim)
+ * An existing custom resource that
+ implements data population (Alpha)
+ In order to use custom resource types
+ that implement data population, the
+ AnyVolumeDataSource feature gate must
+ be enabled. 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.'
properties:
apiGroup:
- description: 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.
+ description: 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.
type: string
kind:
- description: Kind is the type of resource being referenced
+ description: Kind is the type of
+ resource being referenced
type: string
name:
- description: Name is the name of resource being referenced
+ description: Name is the name of
+ resource being referenced
type: string
required:
- kind
- name
type: object
resources:
- description: 'Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'Resources represents the
+ minimum resources the volume should
+ have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
@@ -4278,7 +6813,9 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the
+ maximum amount of compute resources
+ allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -4287,25 +6824,54 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
selector:
- description: A label query over volumes to consider for binding.
+ description: A label query over volumes
+ to consider for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is
+ a list of label selector requirements.
+ The requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector
+ requirement is a selector that
+ contains values, a key, and
+ an operator that relates the
+ key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to
+ a set of values. Valid operators
+ are In, NotIn, Exists and
+ DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -4317,17 +6883,32 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
storageClassName:
- description: 'Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'Name of the StorageClass
+ required by the claim. More info:
+ https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
+ description: volumeMode defines what
+ type of volume is required by the
+ claim. Value of Filesystem is implied
+ when not included in claim spec.
type: string
volumeName:
- description: VolumeName is the binding reference to the PersistentVolume backing this claim.
+ description: VolumeName is the binding
+ reference to the PersistentVolume
+ backing this claim.
type: string
type: object
required:
@@ -4335,90 +6916,157 @@
type: object
type: object
fc:
- description: FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
+ description: FC represents a Fibre Channel resource
+ that is attached to a kubelet's host machine and
+ then exposed to the pod.
properties:
fsType:
- description: 'Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
lun:
description: 'Optional: FC target lun number'
format: int32
type: integer
readOnly:
- description: 'Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'Optional: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.'
type: boolean
targetWWNs:
- description: 'Optional: FC target worldwide names (WWNs)'
+ description: 'Optional: FC target worldwide
+ names (WWNs)'
items:
type: string
type: array
wwids:
- description: 'Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.'
+ description: 'Optional: FC volume world wide
+ identifiers (wwids) Either wwids or combination
+ of targetWWNs and lun must be set, but not
+ both simultaneously.'
items:
type: string
type: array
type: object
flexVolume:
- description: FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
+ description: FlexVolume represents a generic volume
+ resource that is provisioned/attached using an
+ exec based plugin.
properties:
driver:
- description: Driver is the name of the driver to use for this volume.
+ description: Driver is the name of the driver
+ to use for this volume.
type: string
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ The default filesystem depends on FlexVolume
+ script.
type: string
options:
additionalProperties:
type: string
- description: 'Optional: Extra command options if any.'
+ description: 'Optional: Extra command options
+ if any.'
type: object
readOnly:
- description: 'Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'Optional: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.'
type: boolean
secretRef:
- description: '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.'
+ description: '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.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
required:
- driver
type: object
flocker:
- description: Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
+ description: Flocker represents a Flocker volume
+ attached to a kubelet's host machine. This depends
+ on the Flocker control service being running
properties:
datasetName:
- description: Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
+ description: Name of the dataset stored as metadata
+ -> name on the dataset for Flocker should
+ be considered as deprecated
type: string
datasetUUID:
- description: UUID of the dataset. This is unique identifier of a Flocker dataset
+ description: UUID of the dataset. This is unique
+ identifier of a Flocker dataset
type: string
type: object
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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 TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume
+ that you want to mount. Tip: Ensure that the
+ filesystem 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
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: '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). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: '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). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
format: int32
type: integer
pdName:
- description: 'Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'Unique name of the PD resource
+ in GCE. Used to identify the disk in GCE.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: string
readOnly:
- description: 'ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'ReadOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: boolean
required:
- pdName
type: object
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.'
+ 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.'
properties:
directory:
- description: 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.
+ description: 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.
type: string
repository:
description: Repository URL
@@ -4430,75 +7078,121 @@
- repository
type: object
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'
+ 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'
properties:
endpoints:
- description: 'EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'EndpointsName is the endpoint
+ name that details Glusterfs topology. More
+ info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
path:
- description: 'Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'Path is the Glusterfs volume path.
+ More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
required:
- endpoints
- path
type: object
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.'
+ 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.'
properties:
path:
- description: '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'
+ description: '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'
type: string
type:
- description: 'Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
+ description: 'Type for HostPath Volume Defaults
+ to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
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'
+ 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'
properties:
chapAuthDiscovery:
- description: whether support iSCSI Discovery CHAP authentication
+ description: whether support iSCSI Discovery
+ CHAP authentication
type: boolean
chapAuthSession:
- description: whether support iSCSI Session CHAP authentication
+ description: whether support iSCSI Session CHAP
+ authentication
type: boolean
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume
+ that you want to mount. Tip: Ensure that the
+ filesystem 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#iscsi
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
initiatorName:
- description: Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
+ description: Custom iSCSI Initiator Name. If
+ initiatorName is specified with iscsiInterface
+ simultaneously, new iSCSI interface <target
+ portal>:<volume name> will be created for
+ the connection.
type: string
iqn:
description: Target iSCSI Qualified Name.
type: string
iscsiInterface:
- description: iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
+ description: iSCSI Interface Name that uses
+ an iSCSI transport. Defaults to 'default'
+ (tcp).
type: string
lun:
description: iSCSI Target Lun number.
format: int32
type: integer
portals:
- description: 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).
+ description: 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).
items:
type: string
type: array
readOnly:
- description: ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
+ description: ReadOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
type: boolean
secretRef:
- description: CHAP Secret for iSCSI target and initiator authentication
+ description: CHAP Secret for iSCSI target and
+ initiator authentication
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
targetPortal:
- description: 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).
+ description: 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).
type: string
required:
- iqn
@@ -4506,89 +7200,160 @@
- targetPortal
type: object
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'
+ 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'
properties:
path:
- description: 'Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'Path that is exported by the NFS
+ server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
server:
- description: 'Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'Server is the hostname or IP address
+ of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- path
- server
type: object
persistentVolumeClaim:
- description: 'PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'PersistentVolumeClaimVolumeSource
+ represents a reference to a PersistentVolumeClaim
+ in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
claimName:
- description: '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'
+ description: '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'
type: string
readOnly:
- description: Will force the ReadOnly setting in VolumeMounts. Default false.
+ description: Will force the ReadOnly setting
+ in VolumeMounts. Default false.
type: boolean
required:
- claimName
type: object
photonPersistentDisk:
- description: PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
+ description: PhotonPersistentDisk represents a PhotonController
+ persistent disk attached and mounted on kubelets
+ host machine
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
pdID:
- description: ID that identifies Photon Controller persistent disk
+ description: ID that identifies Photon Controller
+ persistent disk
type: string
required:
- pdID
type: object
portworxVolume:
- description: PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
+ description: PortworxVolume represents a portworx
+ volume attached and mounted on kubelets host machine
properties:
fsType:
- description: FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
+ description: FSType represents the filesystem
+ type to mount Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs". Implicitly inferred to be "ext4" if
+ unspecified.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
volumeID:
- description: VolumeID uniquely identifies a Portworx volume
+ description: VolumeID uniquely identifies a
+ Portworx volume
type: string
required:
- volumeID
type: object
projected:
- description: Items for all in one resources secrets, configmaps, and downward API
+ description: Items for all in one resources secrets,
+ configmaps, and downward API
properties:
defaultMode:
- description: 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.
+ description: 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.
format: int32
type: integer
sources:
description: list of volume projections
items:
- description: Projection that may be projected along with other supported volume types
+ description: Projection that may be projected
+ along with other supported volume types
properties:
configMap:
- description: information about the configMap data to project
+ description: information about the configMap
+ data to project
properties:
items:
- description: 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 '..'.
+ description: 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
+ '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to
+ a path within a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -4596,54 +7361,102 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent.
+ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its keys must be defined
+ description: Specify whether the ConfigMap
+ or its keys must be defined
type: boolean
type: object
downwardAPI:
- description: information about the downwardAPI data to project
+ description: information about the downwardAPI
+ data to project
properties:
items:
- description: Items is a list of DownwardAPIVolume file
+ description: Items is a list of DownwardAPIVolume
+ file
items:
- description: DownwardAPIVolumeFile represents information to create the file containing the pod field
+ description: DownwardAPIVolumeFile
+ represents information to create
+ the file containing the pod field
properties:
fieldRef:
- description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
+ description: 'Required: Selects
+ a field of the pod: only annotations,
+ labels, name and namespace
+ are supported.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of
+ the schema the FieldPath
+ is written in terms of,
+ defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the
+ field to select in the
+ specified API version.
type: string
required:
- fieldPath
type: object
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative path name 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 ''..'''
+ description: 'Required: Path
+ is the relative path name
+ 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 ''..'''
type: string
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.'
+ description: 'Selects a resource
+ of the container: only resources
+ limits and requests (limits.cpu,
+ limits.memory, requests.cpu
+ and requests.memory) are currently
+ supported.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container
+ name: required for volumes,
+ optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the
+ output format of the exposed
+ resources, defaults to
+ "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
- description: 'Required: resource to select'
+ description: 'Required:
+ resource to select'
type: string
required:
- resource
@@ -4654,22 +7467,57 @@
type: array
type: object
secret:
- description: information about the secret data to project
+ description: information about the secret
+ data to project
properties:
items:
- description: 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 '..'.
+ description: 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
+ '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to
+ a path within a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -4677,24 +7525,49 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent.
+ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret
+ or its key must be defined
type: boolean
type: object
serviceAccountToken:
- description: information about the serviceAccountToken data to project
+ description: information about the serviceAccountToken
+ data to project
properties:
audience:
- description: 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.
+ description: 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.
type: string
expirationSeconds:
- description: 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.
+ description: 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.
format: int64
type: integer
path:
- description: Path is the path relative to the mount point of the file to project the token into.
+ description: Path is the path relative
+ to the mount point of the file to
+ project the token into.
type: string
required:
- path
@@ -4703,103 +7576,159 @@
type: array
type: object
quobyte:
- description: Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
+ description: Quobyte represents a Quobyte mount
+ on the host that shares a pod's lifetime
properties:
group:
- description: Group to map volume access to Default is no group
+ description: Group to map volume access to Default
+ is no group
type: string
readOnly:
- description: ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
+ description: ReadOnly here will force the Quobyte
+ volume to be mounted with read-only permissions.
+ Defaults to false.
type: boolean
registry:
- description: 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
+ description: 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
type: string
tenant:
- description: Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ description: Tenant owning the given Quobyte
+ volume in the Backend Used with dynamically
+ provisioned Quobyte volumes, value is set
+ by the plugin
type: string
user:
- description: User to map volume access to Defaults to serivceaccount user
+ description: User to map volume access to Defaults
+ to serivceaccount user
type: string
volume:
- description: Volume is a string that references an already created Quobyte volume by name.
+ description: Volume is a string that references
+ an already created Quobyte volume by name.
type: string
required:
- registry
- volume
type: object
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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#rbd TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume
+ that you want to mount. Tip: Ensure that the
+ filesystem 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#rbd
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
image:
- description: 'The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'The rados image name. More info:
+ https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
keyring:
- description: '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'
+ description: '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'
type: string
monitors:
- description: 'A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'A collection of Ceph monitors.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
items:
type: string
type: array
pool:
- description: 'The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'The rados pool name. Default is
+ rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
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'
+ 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'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
user:
- description: 'The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'The rados user name. Default is
+ admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- image
- monitors
type: object
scaleIO:
- description: ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
+ description: ScaleIO represents a ScaleIO persistent
+ volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Default is "xfs".
type: string
gateway:
- description: The host address of the ScaleIO API Gateway.
+ description: The host address of the ScaleIO
+ API Gateway.
type: string
protectionDomain:
- description: The name of the ScaleIO Protection Domain for the configured storage.
+ description: The name of the ScaleIO Protection
+ Domain for the configured storage.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
+ description: SecretRef references to the secret
+ for ScaleIO user and other sensitive information.
+ If this is not provided, Login operation will
+ fail.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
sslEnabled:
- description: Flag to enable/disable SSL communication with Gateway, default false
+ description: Flag to enable/disable SSL communication
+ with Gateway, default false
type: boolean
storageMode:
- description: Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
+ description: Indicates whether the storage for
+ a volume should be ThickProvisioned or ThinProvisioned.
+ Default is ThinProvisioned.
type: string
storagePool:
- description: The ScaleIO Storage Pool associated with the protection domain.
+ description: The ScaleIO Storage Pool associated
+ with the protection domain.
type: string
system:
- description: The name of the storage system as configured in ScaleIO.
+ description: The name of the storage system
+ as configured in ScaleIO.
type: string
volumeName:
- description: The name of a volume already created in the ScaleIO system that is associated with this volume source.
+ description: The name of a volume already created
+ in the ScaleIO system that is associated with
+ this volume source.
type: string
required:
- gateway
@@ -4807,26 +7736,63 @@
- system
type: object
secret:
- description: 'Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'Secret represents a secret that should
+ populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: 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 '..'.
+ description: 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 '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to a path within
+ a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -4834,49 +7800,80 @@
type: object
type: array
optional:
- description: Specify whether the Secret or its keys must be defined
+ description: Specify whether the Secret or its
+ keys must be defined
type: boolean
secretName:
- description: 'Name of the secret in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'Name of the secret in the pod''s
+ namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
type: string
type: object
storageos:
- description: StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
+ description: StorageOS represents a StorageOS volume
+ attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
+ description: SecretRef specifies the secret
+ to use for obtaining the StorageOS API credentials. If
+ not specified, default values will be attempted.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
volumeName:
- description: VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
+ description: VolumeName is the human-readable
+ name of the StorageOS volume. Volume names
+ are only unique within a namespace.
type: string
volumeNamespace:
- description: 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 do not pre-exist within StorageOS will be created.
+ description: 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 do not pre-exist
+ within StorageOS will be created.
type: string
type: object
vsphereVolume:
- description: VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
+ description: VsphereVolume represents a vSphere
+ volume attached and mounted on kubelets host machine
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
storagePolicyID:
- description: Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
+ description: Storage Policy Based Management
+ (SPBM) profile ID associated with the StoragePolicyName.
type: string
storagePolicyName:
- description: Storage Policy Based Management (SPBM) profile name.
+ description: Storage Policy Based Management
+ (SPBM) profile name.
type: string
volumePath:
- description: Path that identifies vSphere volume vmdk
+ description: Path that identifies vSphere volume
+ vmdk
type: string
required:
- volumePath
@@ -4889,7 +7886,8 @@
type: array
type: object
statefulSetOptions:
- description: StatefulSetOptions defines the custom options for the solrCloud StatefulSet.
+ description: StatefulSetOptions defines the custom options for
+ the solrCloud StatefulSet.
properties:
annotations:
additionalProperties:
@@ -4902,7 +7900,11 @@
description: Labels to be added for the StatefulSet.
type: object
podManagementPolicy:
- description: PodManagementPolicy defines the policy for creating pods under a stateful set. Override the default value of Parallel. This cannot be updated on an existing StatefulSet, the StatefulSet must be deleted and recreated for a change in this field to take effect.
+ description: PodManagementPolicy defines the policy for creating
+ pods under a stateful set. Override the default value of
+ Parallel. This cannot be updated on an existing StatefulSet,
+ the StatefulSet must be deleted and recreated for a change
+ in this field to take effect.
enum:
- OrderedReady
- Parallel
@@ -4910,87 +7912,151 @@
type: object
type: object
dataStorage:
- description: Customize how the cloud data is stored. If neither "persistent" or "ephemeral" is provided, then ephemeral storage will be used by default.
+ description: Customize how the cloud data is stored. If neither "persistent"
+ or "ephemeral" is provided, then ephemeral storage will be used
+ by default.
properties:
ephemeral:
- description: "EphemeralStorage is the specification for how the ephemeral Solr data storage should be configured. \n This option cannot be used with the \"persistent\" option. Ephemeral storage is used by default if neither \"persistent\" or \"ephemeral\" is provided."
+ description: "EphemeralStorage is the specification for how the
+ ephemeral Solr data storage should be configured. \n This option
+ cannot be used with the \"persistent\" option. Ephemeral storage
+ is used by default if neither \"persistent\" or \"ephemeral\"
+ is provided."
properties:
emptyDir:
- description: EmptyDirVolumeSource is an optional config for the emptydir volume that will store Solr data.
+ description: EmptyDirVolumeSource is an optional config for
+ the emptydir volume that will store Solr data.
properties:
medium:
- description: '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'
+ description: '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'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
+ description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
hostPath:
- description: "HostPathVolumeSource is an optional config to specify a path on the host machine to store Solr data. \n If hostPath is omitted, then the default EmptyDir is used, otherwise hostPath takes precedence over EmptyDir."
+ description: "HostPathVolumeSource is an optional config to
+ specify a path on the host machine to store Solr data. \n
+ If hostPath is omitted, then the default EmptyDir is used,
+ otherwise hostPath takes precedence over EmptyDir."
properties:
path:
- description: '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'
+ description: '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'
type: string
type:
- description: 'Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
+ description: 'Type for HostPath Volume Defaults to ""
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
type: object
persistent:
- description: "PersistentStorage is the specification for how the persistent Solr data storage should be configured. \n This option cannot be used with the \"ephemeral\" option."
+ description: "PersistentStorage is the specification for how the
+ persistent Solr data storage should be configured. \n This option
+ cannot be used with the \"ephemeral\" option."
properties:
pvcTemplate:
- description: PersistentVolumeClaimTemplate is the PVC object for the solr node to store its data. Within metadata, the Name, Labels and Annotations are able to be specified, but defaults will be provided if necessary. The entire Spec is customizable, however there will be defaults provided if necessary. This field is optional. If no PVC spec is provided, then a default will be provided.
+ description: PersistentVolumeClaimTemplate is the PVC object
+ for the solr node to store its data. Within metadata, the
+ Name, Labels and Annotations are able to be specified, but
+ defaults will be provided if necessary. The entire Spec
+ is customizable, however there will be defaults provided
+ if necessary. This field is optional. If no PVC spec is
+ provided, then a default will be provided.
properties:
metadata:
- description: 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.
+ description: 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.
properties:
annotations:
additionalProperties:
type: string
- description: 'Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
+ description: 'Annotations is an unstructured key value
+ map stored with a resource that may be set by external
+ tools to store and retrieve arbitrary metadata.
+ They are not queryable and should be preserved when
+ modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
type: object
labels:
additionalProperties:
type: string
- description: 'Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels'
+ description: 'Map of string keys and values that can
+ be used to organize and categorize (scope and select)
+ objects. May match selectors of replication controllers
+ and services. More info: http://kubernetes.io/docs/user-guide/labels'
type: object
name:
- description: 'Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
+ description: 'Name must be unique within a namespace.
+ Is required when creating resources, although some
+ resources may allow a client to request the generation
+ of an appropriate name automatically. Name is primarily
+ intended for creation idempotence and configuration
+ definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
type: string
type: object
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.
+ 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.
properties:
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'
+ description: 'AccessModes contains the desired access
+ modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. 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.'
+ description: 'This field can be used to specify either:
+ * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
+ * An existing PVC (PersistentVolumeClaim) * An existing
+ custom resource that implements data population
+ (Alpha) In order to use custom resource types that
+ implement data population, the AnyVolumeDataSource
+ feature gate must be enabled. 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.'
properties:
apiGroup:
- description: 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.
+ description: 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.
type: string
kind:
- description: Kind is the type of resource being referenced
+ description: Kind is the type of resource being
+ referenced
type: string
name:
- description: Name is the name of resource being referenced
+ description: Name is the name of resource being
+ referenced
type: string
required:
- kind
- name
type: object
resources:
- description: 'Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'Resources represents the minimum resources
+ the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
@@ -4999,7 +8065,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -5008,25 +8075,43 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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. More info:
+ https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
selector:
- description: A label query over volumes to consider for binding.
+ description: A label query over volumes to consider
+ for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label
+ selector requirements. The requirements are
+ ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement is
+ a selector that contains values, a key, and
+ an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label key that the
+ selector applies to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's
+ relationship to a set of values. Valid
+ operators are In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5038,22 +8123,38 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
storageClassName:
- description: 'Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'Name of the StorageClass required by
+ the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
+ description: volumeMode defines what type of volume
+ is required by the claim. Value of Filesystem is
+ implied when not included in claim spec.
type: string
volumeName:
- description: VolumeName is the binding reference to the PersistentVolume backing this claim.
+ description: VolumeName is the binding reference to
+ the PersistentVolume backing this claim.
type: string
type: object
type: object
reclaimPolicy:
- description: 'VolumeReclaimPolicy determines how the Solr Cloud''s PVCs will be treated after the cloud is deleted. - Retain: This is the default Kubernetes policy, where PVCs created for StatefulSets are not deleted when the StatefulSet is deleted. - Delete: The PVCs will be deleted by the Solr Operator after the SolrCloud object is deleted. The default value is Retain, so no data will be deleted unless explicitly configured.'
+ description: 'VolumeReclaimPolicy determines how the Solr
+ Cloud''s PVCs will be treated after the cloud is deleted. -
+ Retain: This is the default Kubernetes policy, where PVCs
+ created for StatefulSets are not deleted when the StatefulSet
+ is deleted. - Delete: The PVCs will be deleted by the
+ Solr Operator after the SolrCloud object is deleted. The
+ default value is Retain, so no data will be deleted unless
+ explicitly configured.'
enum:
- Retain
- Delete
@@ -5065,182 +8166,302 @@
format: int32
type: integer
solrAddressability:
- description: Customize how Solr is addressed both internally and externally in Kubernetes.
+ description: Customize how Solr is addressed both internally and externally
+ in Kubernetes.
properties:
commonServicePort:
- description: CommonServicePort defines the port to have the common Solr service listen on. Defaults to 80 (when not using TLS) or 443 (when using TLS)
+ description: CommonServicePort defines the port to have the common
+ Solr service listen on. Defaults to 80 (when not using TLS)
+ or 443 (when using TLS)
type: integer
external:
- description: External defines the way in which this SolrCloud nodes should be made addressable externally, from outside the Kubernetes cluster. If none is provided, the Solr Cloud will not be made addressable externally.
+ description: External defines the way in which this SolrCloud
+ nodes should be made addressable externally, from outside the
+ Kubernetes cluster. If none is provided, the Solr Cloud will
+ not be made addressable externally.
properties:
additionalDomainNames:
- description: Provide additional domainNames that the Ingress or ExternalDNS should listen on. This option is ignored with the LoadBalancer method.
+ description: Provide additional domainNames that the Ingress
+ or ExternalDNS should listen on. This option is ignored
+ with the LoadBalancer method.
items:
type: string
type: array
additionalDomains:
- description: "Provide additional domainNames that the Ingress or ExternalDNS should listen on. This option is ignored with the LoadBalancer method. \n DEPRECATED: Please use additionalDomainNames instead. This will be removed in a future version."
+ description: "Provide additional domainNames that the Ingress
+ or ExternalDNS should listen on. This option is ignored
+ with the LoadBalancer method. \n DEPRECATED: Please use
+ additionalDomainNames instead. This will be removed in a
+ future version."
items:
type: string
type: array
domainName:
- description: "Override the domainName provided as startup parameters to the operator, used by ingresses and externalDNS. The common and/or node services will be addressable by unique names under the given domain. e.g. given.domain.name.com -> default-example-solrcloud.given.domain.name.com \n For the LoadBalancer method, this field is optional and will only be used when useExternalAddress=true. If used with the LoadBalancer method, you will need DNS routing to the LoadBalancer IP address through the url template given above."
+ description: "Override the domainName provided as startup
+ parameters to the operator, used by ingresses and externalDNS.
+ The common and/or node services will be addressable by unique
+ names under the given domain. e.g. given.domain.name.com
+ -> default-example-solrcloud.given.domain.name.com \n For
+ the LoadBalancer method, this field is optional and will
+ only be used when useExternalAddress=true. If used with
+ the LoadBalancer method, you will need DNS routing to the
+ LoadBalancer IP address through the url template given above."
type: string
hideCommon:
- description: Do not expose the common Solr service externally. This affects a single service. Defaults to false.
+ description: Do not expose the common Solr service externally.
+ This affects a single service. Defaults to false.
type: boolean
hideNodes:
- description: Do not expose each of the Solr Node services externally. The number of services this affects could range from 1 (a headless service for ExternalDNS) to the number of Solr pods your cloud contains (individual node services for Ingress/LoadBalancer). Defaults to false.
+ description: Do not expose each of the Solr Node services
+ externally. The number of services this affects could range
+ from 1 (a headless service for ExternalDNS) to the number
+ of Solr pods your cloud contains (individual node services
+ for Ingress/LoadBalancer). Defaults to false.
type: boolean
ingressTLSTermination:
- description: "IngressTLSTermination tells the SolrCloud Ingress to terminate TLS on incoming connections. \n This is option is only available when Method=Ingress, because ExternalDNS and LoadBalancer Services do not support TLS termination. This option is also unavailable when the SolrCloud has TLS enabled via `spec.solrTLS`, in this case the Ingress cannot terminate TLS before reaching Solr. \n When using this option, the UseExternalAddress option will be disabled, since Solr cannot be running in HTTP mode and making internal requests in HTTPS."
+ description: "IngressTLSTermination tells the SolrCloud Ingress
+ to terminate TLS on incoming connections. \n This is option
+ is only available when Method=Ingress, because ExternalDNS
+ and LoadBalancer Services do not support TLS termination.
+ This option is also unavailable when the SolrCloud has TLS
+ enabled via `spec.solrTLS`, in this case the Ingress cannot
+ terminate TLS before reaching Solr. \n When using this option,
+ the UseExternalAddress option will be disabled, since Solr
+ cannot be running in HTTP mode and making internal requests
+ in HTTPS."
maxProperties: 1
properties:
tlsSecret:
- description: TLSSecret defines a TLS Secret to use for TLS termination of all exposed addresses for this SolrCloud in the Ingress.
+ description: TLSSecret defines a TLS Secret to use for
+ TLS termination of all exposed addresses for this SolrCloud
+ in the Ingress.
type: string
useDefaultTLSSecret:
- description: "UseDefaultTLSSecret determines whether the ingress should use the default TLS secret provided by the Ingress implementation. \n For example, using nginx: https://kubernetes.github.io/ingress-nginx/user-guide/tls/#default-ssl-certificate"
+ description: "UseDefaultTLSSecret determines whether the
+ ingress should use the default TLS secret provided by
+ the Ingress implementation. \n For example, using nginx:
+ https://kubernetes.github.io/ingress-nginx/user-guide/tls/#default-ssl-certificate"
type: boolean
type: object
ingressTLSTerminationSecret:
- description: "IngressTLSTerminationSecret defines a TLS Secret to use for TLS termination of all exposed addresses in the ingress. \n This is option is only available when Method=Ingress, because ExternalDNS and LoadBalancer Services do not support TLS termination. This option is also unavailable when the SolrCloud has TLS enabled via `spec.solrTLS`, in this case the Ingress cannot terminate TLS before reaching Solr. \n When using this option, the UseExternalAddress option will be disabled, since Solr cannot be running in HTTP mode and making internal requests in HTTPS. \n DEPRECATED: Use ingressTLSTermination.tlsSecret instead"
+ description: "IngressTLSTerminationSecret defines a TLS Secret
+ to use for TLS termination of all exposed addresses in the
+ ingress. \n This is option is only available when Method=Ingress,
+ because ExternalDNS and LoadBalancer Services do not support
+ TLS termination. This option is also unavailable when the
+ SolrCloud has TLS enabled via `spec.solrTLS`, in this case
+ the Ingress cannot terminate TLS before reaching Solr. \n
+ When using this option, the UseExternalAddress option will
+ be disabled, since Solr cannot be running in HTTP mode and
+ making internal requests in HTTPS. \n DEPRECATED: Use ingressTLSTermination.tlsSecret
+ instead"
type: string
method:
- description: The way in which this SolrCloud's service(s) should be made addressable externally.
+ description: The way in which this SolrCloud's service(s)
+ should be made addressable externally.
enum:
- Ingress
- ExternalDNS
type: string
nodePortOverride:
- description: "NodePortOverride defines the port to have all Solr node service(s) listen on and advertise itself as if advertising through an Ingress or LoadBalancer. This overrides the default usage of the podPort. \n This is option is only used when HideNodes=false, otherwise the the port each Solr Node will advertise itself with the podPort. This option is also unavailable with the ExternalDNS method. \n If using method=Ingress, your ingress controller is required to listen on this port. If your ingress controller is not listening on the podPort, then this option is required for solr to be addressable via an Ingress. \n Defaults to 80 (without TLS) or 443 (with TLS) if HideNodes=false and method=Ingress, otherwise this is optional."
+ description: "NodePortOverride defines the port to have all
+ Solr node service(s) listen on and advertise itself as if
+ advertising through an Ingress or LoadBalancer. This overrides
+ the default usage of the podPort. \n This is option is only
+ used when HideNodes=false, otherwise the the port each Solr
+ Node will advertise itself with the podPort. This option
+ is also unavailable with the ExternalDNS method. \n If using
+ method=Ingress, your ingress controller is required to listen
+ on this port. If your ingress controller is not listening
+ on the podPort, then this option is required for solr to
+ be addressable via an Ingress. \n Defaults to 80 (without
+ TLS) or 443 (with TLS) if HideNodes=false and method=Ingress,
+ otherwise this is optional."
type: integer
useExternalAddress:
- description: "Use the external address to advertise the SolrNode, defaults to false. \n If false, the external address will be available, however Solr (and clients using the CloudSolrClient in SolrJ) will only be aware of the internal URLs. If true, Solr will startup with the hostname of the external address. \n NOTE: This option cannot be true when hideNodes is set to true. So it will be auto-set to false if that is the case."
+ description: "Use the external address to advertise the SolrNode,
+ defaults to false. \n If false, the external address will
+ be available, however Solr (and clients using the CloudSolrClient
+ in SolrJ) will only be aware of the internal URLs. If true,
+ Solr will startup with the hostname of the external address.
+ \n NOTE: This option cannot be true when hideNodes is set
+ to true. So it will be auto-set to false if that is the
+ case."
type: boolean
required:
- domainName
- method
type: object
kubeDomain:
- description: KubeDomain allows for the specification of an override of the default "cluster.local" Kubernetes cluster domain. Only use this option if the Kubernetes cluster has been setup with a custom domain.
+ description: KubeDomain allows for the specification of an override
+ of the default "cluster.local" Kubernetes cluster domain. Only
+ use this option if the Kubernetes cluster has been setup with
+ a custom domain.
type: string
podPort:
- description: PodPort defines the port to have the Solr Pod listen on. Defaults to 8983
+ description: PodPort defines the port to have the Solr Pod listen
+ on. Defaults to 8983
type: integer
type: object
solrClientTLS:
- description: Options to configure client TLS certificate for Solr pods
+ description: Options to configure client TLS certificate for Solr
+ pods
properties:
checkPeerName:
- description: TLS certificates contain host/ip "peer name" information that is validated by default.
+ description: TLS certificates contain host/ip "peer name" information
+ that is validated by default.
type: boolean
clientAuth:
default: None
- description: Determines the client authentication method, either None, Want, or Need; this affects K8s ability to call liveness / readiness probes so use cautiously. Only applies for server certificates, has no effect on client certificates
+ description: Determines the client authentication method, either
+ None, Want, or Need; this affects K8s ability to call liveness
+ / readiness probes so use cautiously. Only applies for server
+ certificates, has no effect on client certificates
enum:
- None
- Want
- Need
type: string
keyStorePasswordSecret:
- description: Secret containing the key store password; this field is required unless mountedTLSDir is used, as most JVMs do not support pkcs12 keystores without a password
+ description: Secret containing the key store password; this field
+ is required unless mountedTLSDir is used, as most JVMs do not
+ support pkcs12 keystores without a password
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
mountedTLSDir:
- description: Used to specify a path where the keystore, truststore, and password files for the TLS certificate are mounted by an external agent or CSI driver. This option is typically used with `spec.updateStrategy.restartSchedule` to restart Solr pods before the mounted TLS cert expires.
+ description: Used to specify a path where the keystore, truststore,
+ and password files for the TLS certificate are mounted by an
+ external agent or CSI driver. This option is typically used
+ with `spec.updateStrategy.restartSchedule` to restart Solr pods
+ before the mounted TLS cert expires.
properties:
keystoreFile:
- description: Override the name of the keystore file; no default, if you don't supply this setting, then the corresponding env vars and Java system properties will not be configured for the pod template
+ description: Override the name of the keystore file; no default,
+ if you don't supply this setting, then the corresponding
+ env vars and Java system properties will not be configured
+ for the pod template
type: string
keystorePasswordFile:
- description: Override the name of the keystore password file; defaults to keystore-password
+ description: Override the name of the keystore password file;
+ defaults to keystore-password
type: string
path:
- description: The path on the main Solr container where the TLS files are mounted by some external agent or CSI Driver
+ description: The path on the main Solr container where the
+ TLS files are mounted by some external agent or CSI Driver
type: string
truststoreFile:
- description: Override the name of the truststore file; no default, if you don't supply this setting, then the corresponding env vars and Java system properties will not be configured for the pod template
+ description: Override the name of the truststore file; no
+ default, if you don't supply this setting, then the corresponding
+ env vars and Java system properties will not be configured
+ for the pod template
type: string
truststorePasswordFile:
- description: Override the name of the truststore password file; defaults to the same value as the KeystorePasswordFile
+ description: Override the name of the truststore password
+ file; defaults to the same value as the KeystorePasswordFile
type: string
required:
- path
type: object
pkcs12Secret:
- description: TLS Secret containing a pkcs12 keystore; required for Solr pods unless mountedTLSDir is used
+ description: TLS Secret containing a pkcs12 keystore; required
+ for Solr pods unless mountedTLSDir is used
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
restartOnTLSSecretUpdate:
- description: Opt-in flag to restart Solr pods after TLS secret updates, such as if the cert is renewed; default is false. This option only applies when using the `spec.solrTLS.pkcs12Secret` option; when using the `spec.solrTLS.mountedTLSDir` option, you need to ensure pods get restarted before the certs expire, see `spec.updateStrategy.restartSchedule` for scheduling restarts.
+ description: Opt-in flag to restart Solr pods after TLS secret
+ updates, such as if the cert is renewed; default is false. This
+ option only applies when using the `spec.solrTLS.pkcs12Secret`
+ option; when using the `spec.solrTLS.mountedTLSDir` option,
+ you need to ensure pods get restarted before the certs expire,
+ see `spec.updateStrategy.restartSchedule` for scheduling restarts.
type: boolean
trustStorePasswordSecret:
- description: Secret containing the trust store password; if not provided the keyStorePassword will be used
+ description: Secret containing the trust store password; if not
+ provided the keyStorePassword will be used
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
trustStoreSecret:
- description: TLS Secret containing a pkcs12 truststore; if not provided, then the keystore and password are used for the truststore The specified key is used as the truststore file name when mounted into Solr pods
+ description: TLS Secret containing a pkcs12 truststore; if not
+ provided, then the keystore and password are used for the truststore
+ The specified key is used as the truststore file name when mounted
+ into Solr pods
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
verifyClientHostname:
- description: Verify client's hostname during SSL handshake Only applies for server configuration
+ description: Verify client's hostname during SSL handshake Only
+ applies for server configuration
type: boolean
type: object
solrGCTune:
- description: Set GC Tuning configuration through GC_TUNE environment variable
+ description: Set GC Tuning configuration through GC_TUNE environment
+ variable
type: string
solrImage:
- description: ContainerImage defines the fields needed for a Docker repository image. The format here matches the predominant format used in Helm charts.
+ description: ContainerImage defines the fields needed for a Docker
+ repository image. The format here matches the predominant format
+ used in Helm charts.
properties:
imagePullSecret:
type: string
pullPolicy:
- description: PullPolicy describes a policy for if/when to pull a container image
+ description: PullPolicy describes a policy for if/when to pull
+ a container image
type: string
repository:
type: string
@@ -5253,147 +8474,229 @@
description: Set the Solr Log level, defaults to INFO
type: string
solrModules:
- description: 'List of Solr Modules to be loaded when starting Solr Note: You do not need to specify a module if it is required by another property (e.g. backupRepositories[].gcs)'
+ description: 'List of Solr Modules to be loaded when starting Solr
+ Note: You do not need to specify a module if it is required by another
+ property (e.g. backupRepositories[].gcs)'
items:
type: string
type: array
solrOpts:
- description: You can add common system properties to the SOLR_OPTS environment variable SolrOpts is the string interface for these optional settings
+ description: You can add common system properties to the SOLR_OPTS
+ environment variable SolrOpts is the string interface for these
+ optional settings
type: string
solrSecurity:
description: Options to enable Solr security
properties:
authenticationType:
- description: Indicates the authentication plugin type that is being used by Solr; for now only "Basic" is supported by the Solr operator but support for other authentication plugins may be added in the future.
+ description: Indicates the authentication plugin type that is
+ being used by Solr; for now only "Basic" is supported by the
+ Solr operator but support for other authentication plugins may
+ be added in the future.
enum:
- Basic
type: string
basicAuthSecret:
- description: "Secret (kubernetes.io/basic-auth) containing credentials the operator should use for API requests to secure Solr pods. If you provide this secret, then the operator assumes you've also configured your own security.json file and uploaded it to Solr. If you change the password for this user using the Solr security API, then you *must* update the secret with the new password or the operator will be locked out of Solr and API requests will fail, ultimately causing a CrashBackoffLoop for all pods if probe endpoints are secured (see 'probesRequireAuth' setting). \n If you don't supply this secret, then the operator creates a kubernetes.io/basic-auth secret containing the password for the \"k8s-oper\" user. All API requests from the operator are made as the \"k8s-oper\" user, which is configured with read-only access to a minimal set of endpoints. In addition, the operator bootstraps a default security.json file and credentials for two additional users: admin and solr. The 'solr' user has basic read access to Solr resources. Once the security.json is bootstrapped, the operator will not update it! You're expected to use the 'admin' user to access the Security API to make further changes. It's strictly a bootstrapping operation."
+ description: "Secret (kubernetes.io/basic-auth) containing credentials
+ the operator should use for API requests to secure Solr pods.
+ If you provide this secret, then the operator assumes you've
+ also configured your own security.json file and uploaded it
+ to Solr. If you change the password for this user using the
+ Solr security API, then you *must* update the secret with the
+ new password or the operator will be locked out of Solr and
+ API requests will fail, ultimately causing a CrashBackoffLoop
+ for all pods if probe endpoints are secured (see 'probesRequireAuth'
+ setting). \n If you don't supply this secret, then the operator
+ creates a kubernetes.io/basic-auth secret containing the password
+ for the \"k8s-oper\" user. All API requests from the operator
+ are made as the \"k8s-oper\" user, which is configured with
+ read-only access to a minimal set of endpoints. In addition,
+ the operator bootstraps a default security.json file and credentials
+ for two additional users: admin and solr. The 'solr' user has
+ basic read access to Solr resources. Once the security.json
+ is bootstrapped, the operator will not update it! You're expected
+ to use the 'admin' user to access the Security API to make further
+ changes. It's strictly a bootstrapping operation."
type: string
bootstrapSecurityJson:
- description: Configure a user-provided security.json from a secret to allow for advanced security config. If not specified, the operator bootstraps a security.json with basic auth enabled. This is a bootstrapping config only; once Solr is initialized, the security config should be managed by the security API.
+ description: Configure a user-provided security.json from a secret
+ to allow for advanced security config. If not specified, the
+ operator bootstraps a security.json with basic auth enabled.
+ This is a bootstrapping config only; once Solr is initialized,
+ the security config should be managed by the security API.
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
probesRequireAuth:
- description: Flag to indicate if the configured HTTP endpoint(s) used for the probes require authentication; defaults to false. If you set to true, then probes will use a local command on the main container to hit the secured endpoints with credentials sourced from an env var instead of HTTP directly.
+ description: Flag to indicate if the configured HTTP endpoint(s)
+ used for the probes require authentication; defaults to false.
+ If you set to true, then probes will use a local command on
+ the main container to hit the secured endpoints with credentials
+ sourced from an env var instead of HTTP directly.
type: boolean
type: object
solrTLS:
- description: Options to enable the server TLS certificate for Solr pods
+ description: Options to enable the server TLS certificate for Solr
+ pods
properties:
checkPeerName:
- description: TLS certificates contain host/ip "peer name" information that is validated by default.
+ description: TLS certificates contain host/ip "peer name" information
+ that is validated by default.
type: boolean
clientAuth:
default: None
- description: Determines the client authentication method, either None, Want, or Need; this affects K8s ability to call liveness / readiness probes so use cautiously. Only applies for server certificates, has no effect on client certificates
+ description: Determines the client authentication method, either
+ None, Want, or Need; this affects K8s ability to call liveness
+ / readiness probes so use cautiously. Only applies for server
+ certificates, has no effect on client certificates
enum:
- None
- Want
- Need
type: string
keyStorePasswordSecret:
- description: Secret containing the key store password; this field is required unless mountedTLSDir is used, as most JVMs do not support pkcs12 keystores without a password
+ description: Secret containing the key store password; this field
+ is required unless mountedTLSDir is used, as most JVMs do not
+ support pkcs12 keystores without a password
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
mountedTLSDir:
- description: Used to specify a path where the keystore, truststore, and password files for the TLS certificate are mounted by an external agent or CSI driver. This option is typically used with `spec.updateStrategy.restartSchedule` to restart Solr pods before the mounted TLS cert expires.
+ description: Used to specify a path where the keystore, truststore,
+ and password files for the TLS certificate are mounted by an
+ external agent or CSI driver. This option is typically used
+ with `spec.updateStrategy.restartSchedule` to restart Solr pods
+ before the mounted TLS cert expires.
properties:
keystoreFile:
- description: Override the name of the keystore file; no default, if you don't supply this setting, then the corresponding env vars and Java system properties will not be configured for the pod template
+ description: Override the name of the keystore file; no default,
+ if you don't supply this setting, then the corresponding
+ env vars and Java system properties will not be configured
+ for the pod template
type: string
keystorePasswordFile:
- description: Override the name of the keystore password file; defaults to keystore-password
+ description: Override the name of the keystore password file;
+ defaults to keystore-password
type: string
path:
- description: The path on the main Solr container where the TLS files are mounted by some external agent or CSI Driver
+ description: The path on the main Solr container where the
+ TLS files are mounted by some external agent or CSI Driver
type: string
truststoreFile:
- description: Override the name of the truststore file; no default, if you don't supply this setting, then the corresponding env vars and Java system properties will not be configured for the pod template
+ description: Override the name of the truststore file; no
+ default, if you don't supply this setting, then the corresponding
+ env vars and Java system properties will not be configured
+ for the pod template
type: string
truststorePasswordFile:
- description: Override the name of the truststore password file; defaults to the same value as the KeystorePasswordFile
+ description: Override the name of the truststore password
+ file; defaults to the same value as the KeystorePasswordFile
type: string
required:
- path
type: object
pkcs12Secret:
- description: TLS Secret containing a pkcs12 keystore; required for Solr pods unless mountedTLSDir is used
+ description: TLS Secret containing a pkcs12 keystore; required
+ for Solr pods unless mountedTLSDir is used
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
restartOnTLSSecretUpdate:
- description: Opt-in flag to restart Solr pods after TLS secret updates, such as if the cert is renewed; default is false. This option only applies when using the `spec.solrTLS.pkcs12Secret` option; when using the `spec.solrTLS.mountedTLSDir` option, you need to ensure pods get restarted before the certs expire, see `spec.updateStrategy.restartSchedule` for scheduling restarts.
+ description: Opt-in flag to restart Solr pods after TLS secret
+ updates, such as if the cert is renewed; default is false. This
+ option only applies when using the `spec.solrTLS.pkcs12Secret`
+ option; when using the `spec.solrTLS.mountedTLSDir` option,
+ you need to ensure pods get restarted before the certs expire,
+ see `spec.updateStrategy.restartSchedule` for scheduling restarts.
type: boolean
trustStorePasswordSecret:
- description: Secret containing the trust store password; if not provided the keyStorePassword will be used
+ description: Secret containing the trust store password; if not
+ provided the keyStorePassword will be used
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
trustStoreSecret:
- description: TLS Secret containing a pkcs12 truststore; if not provided, then the keystore and password are used for the truststore The specified key is used as the truststore file name when mounted into Solr pods
+ description: TLS Secret containing a pkcs12 truststore; if not
+ provided, then the keystore and password are used for the truststore
+ The specified key is used as the truststore file name when mounted
+ into Solr pods
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must be
+ a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must be
+ defined
type: boolean
required:
- key
type: object
verifyClientHostname:
- description: Verify client's hostname during SSL handshake Only applies for server configuration
+ description: Verify client's hostname during SSL handshake Only
+ applies for server configuration
type: boolean
type: object
solrZkOpts:
- description: This will add java system properties for connecting to Zookeeper. SolrZkOpts is the string interface for these optional settings
+ description: This will add java system properties for connecting to
+ Zookeeper. SolrZkOpts is the string interface for these optional
+ settings
type: string
updateStrategy:
description: Define how Solr rolling updates are executed.
@@ -5405,43 +8708,72 @@
anyOf:
- type: integer
- type: string
- description: "The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of the desired number of pods (ex: 10%). Absolute number is calculated from percentage by rounding down. If the provided number is 0 or negative, then all pods will be allowed to be updated in unison. \n Defaults to 25%."
+ description: "The maximum number of pods that can be unavailable
+ during the update. Value can be an absolute number (ex:
+ 5) or a percentage of the desired number of pods (ex: 10%).
+ Absolute number is calculated from percentage by rounding
+ down. If the provided number is 0 or negative, then all
+ pods will be allowed to be updated in unison. \n Defaults
+ to 25%."
x-kubernetes-int-or-string: true
maxShardReplicasUnavailable:
anyOf:
- type: integer
- type: string
- description: "The maximum number of replicas for each shard that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of replicas in a shard (ex: 25%). Absolute number is calculated from percentage by rounding down. If the provided number is 0 or negative, then all replicas will be allowed to be updated in unison. \n Defaults to 1."
+ description: "The maximum number of replicas for each shard
+ that can be unavailable during the update. Value can be
+ an absolute number (ex: 5) or a percentage of replicas in
+ a shard (ex: 25%). Absolute number is calculated from percentage
+ by rounding down. If the provided number is 0 or negative,
+ then all replicas will be allowed to be updated in unison.
+ \n Defaults to 1."
x-kubernetes-int-or-string: true
type: object
method:
- description: Method defines the way in which SolrClouds should be updated when the podSpec changes.
+ description: Method defines the way in which SolrClouds should
+ be updated when the podSpec changes.
enum:
- Managed
- StatefulSet
- Manual
type: string
restartSchedule:
- description: "Perform a scheduled restart on the given schedule, in CRON format. \n Multiple CRON syntaxes are supported - Standard CRON (e.g. \"CRON_TZ=Asia/Seoul 0 6 * * ?\") - Predefined Schedules (e.g. \"@yearly\", \"@weekly\", etc.) - Intervals (e.g. \"@every 10h30m\") \n For more information please check this reference: https://pkg.go.dev/github.com/robfig/cron/v3?utm_source=godoc#hdr-CRON_Expression_Format"
+ description: "Perform a scheduled restart on the given schedule,
+ in CRON format. \n Multiple CRON syntaxes are supported -
+ Standard CRON (e.g. \"CRON_TZ=Asia/Seoul 0 6 * * ?\") - Predefined
+ Schedules (e.g. \"@yearly\", \"@weekly\", etc.) - Intervals
+ (e.g. \"@every 10h30m\") \n For more information please check
+ this reference: https://pkg.go.dev/github.com/robfig/cron/v3?utm_source=godoc#hdr-CRON_Expression_Format"
type: string
type: object
zookeeperRef:
- description: The information for the Zookeeper this SolrCloud should connect to Can be a zookeeper that is running, or one that is created by the solr operator
+ description: The information for the Zookeeper this SolrCloud should
+ connect to Can be a zookeeper that is running, or one that is created
+ by the solr operator
properties:
connectionInfo:
- description: A zookeeper ensemble that is run independently of the solr operator If an externalConnectionString is provided, but no internalConnectionString is, the external will be used as the internal
+ description: A zookeeper ensemble that is run independently of
+ the solr operator If an externalConnectionString is provided,
+ but no internalConnectionString is, the external will be used
+ as the internal
properties:
acl:
- description: ZooKeeper ACL to use when connecting with ZK. This ACL should have ALL permission in the given chRoot.
+ description: ZooKeeper ACL to use when connecting with ZK.
+ This ACL should have ALL permission in the given chRoot.
properties:
passwordKey:
- description: The name of the key in the given secret that contains the ACL password
+ description: The name of the key in the given secret that
+ contains the ACL password
type: string
secret:
- description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
+ description: The name of the Kubernetes Secret that stores
+ the username and password for the ACL. This secret must
+ be in the same namespace as the solrCloud or prometheusExporter
+ is running in.
type: string
usernameKey:
- description: The name of the key in the given secret that contains the ACL username
+ description: The name of the key in the given secret that
+ contains the ACL username
type: string
required:
- passwordKey
@@ -5452,22 +8784,33 @@
description: The ChRoot to connect solr at
type: string
externalConnectionString:
- description: The connection string to connect to the ensemble from outside of the Kubernetes cluster If external and no internal connection string is provided, the external cnx string will be used as the internal cnx string
+ description: The connection string to connect to the ensemble
+ from outside of the Kubernetes cluster If external and no
+ internal connection string is provided, the external cnx
+ string will be used as the internal cnx string
type: string
internalConnectionString:
- description: The connection string to connect to the ensemble from within the Kubernetes cluster
+ description: The connection string to connect to the ensemble
+ from within the Kubernetes cluster
type: string
readOnlyAcl:
- description: ZooKeeper ACL to use when connecting with ZK for reading operations. This ACL should have READ permission in the given chRoot.
+ description: ZooKeeper ACL to use when connecting with ZK
+ for reading operations. This ACL should have READ permission
+ in the given chRoot.
properties:
passwordKey:
- description: The name of the key in the given secret that contains the ACL password
+ description: The name of the key in the given secret that
+ contains the ACL password
type: string
secret:
- description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
+ description: The name of the Kubernetes Secret that stores
+ the username and password for the ACL. This secret must
+ be in the same namespace as the solrCloud or prometheusExporter
+ is running in.
type: string
usernameKey:
- description: The name of the key in the given secret that contains the ACL username
+ description: The name of the key in the given secret that
+ contains the ACL username
type: string
required:
- passwordKey
@@ -5476,19 +8819,29 @@
type: object
type: object
provided:
- description: 'Create a new Zookeeper Ensemble with the following spec Note: This option will not allow the SolrCloud to run across kube-clusters. Note: Requires - The zookeeperOperator flag to be provided to the Solr Operator - A zookeeper operator to be running'
+ description: 'Create a new Zookeeper Ensemble with the following
+ spec Note: This option will not allow the SolrCloud to run across
+ kube-clusters. Note: Requires - The zookeeperOperator flag
+ to be provided to the Solr Operator - A zookeeper operator
+ to be running'
properties:
acl:
- description: ZooKeeper ACL to use when connecting with ZK. This ACL should have ALL permission in the given chRoot.
+ description: ZooKeeper ACL to use when connecting with ZK.
+ This ACL should have ALL permission in the given chRoot.
properties:
passwordKey:
- description: The name of the key in the given secret that contains the ACL password
+ description: The name of the key in the given secret that
+ contains the ACL password
type: string
secret:
- description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
+ description: The name of the Kubernetes Secret that stores
+ the username and password for the ACL. This secret must
+ be in the same namespace as the solrCloud or prometheusExporter
+ is running in.
type: string
usernameKey:
- description: The name of the key in the given secret that contains the ACL username
+ description: The name of the key in the given secret that
+ contains the ACL username
type: string
required:
- passwordKey
@@ -5504,69 +8857,123 @@
additionalConfig:
additionalProperties:
type: string
- description: key-value map of additional zookeeper configuration parameters
+ description: key-value map of additional zookeeper configuration
+ parameters
type: object
x-kubernetes-preserve-unknown-fields: true
autoPurgePurgeInterval:
- description: "The time interval in hours for which the purge task has to be triggered \n Disabled by default"
+ description: "The time interval in hours for which the
+ purge task has to be triggered \n Disabled by default"
type: integer
autoPurgeSnapRetainCount:
- description: "Retain the snapshots according to retain count \n The default value is 3"
+ description: "Retain the snapshots according to retain
+ count \n The default value is 3"
type: integer
commitLogCount:
- description: "Zookeeper maintains an in-memory list of last committed requests for fast synchronization with followers \n The default value is 500"
+ description: "Zookeeper maintains an in-memory list of
+ last committed requests for fast synchronization with
+ followers \n The default value is 500"
type: integer
globalOutstandingLimit:
- description: "Clients can submit requests faster than ZooKeeper can process them, especially if there are a lot of clients. Zookeeper will throttle Clients so that requests won't exceed global outstanding limit. \n The default value is 1000"
+ description: "Clients can submit requests faster than
+ ZooKeeper can process them, especially if there are
+ a lot of clients. Zookeeper will throttle Clients so
+ that requests won't exceed global outstanding limit.
+ \n The default value is 1000"
type: integer
initLimit:
- description: "InitLimit is the amount of time, in ticks, to allow followers to connect and sync to a leader. \n Default value is 10."
+ description: "InitLimit is the amount of time, in ticks,
+ to allow followers to connect and sync to a leader.
+ \n Default value is 10."
type: integer
maxClientCnxns:
- description: "Limits the number of concurrent connections that a single client, identified by IP address, may make to a single member of the ZooKeeper ensemble. \n The default value is 60"
+ description: "Limits the number of concurrent connections
+ that a single client, identified by IP address, may
+ make to a single member of the ZooKeeper ensemble. \n
+ The default value is 60"
type: integer
maxCnxns:
- description: "Limits the total number of concurrent connections that can be made to a zookeeper server \n The defult value is 0, indicating no limit"
+ description: "Limits the total number of concurrent connections
+ that can be made to a zookeeper server \n The defult
+ value is 0, indicating no limit"
type: integer
maxSessionTimeout:
- description: "The maximum session timeout in milliseconds that the server will allow the client to negotiate. \n The default value is 40000"
+ description: "The maximum session timeout in milliseconds
+ that the server will allow the client to negotiate.
+ \n The default value is 40000"
type: integer
minSessionTimeout:
- description: "The minimum session timeout in milliseconds that the server will allow the client to negotiate \n The default value is 4000"
+ description: "The minimum session timeout in milliseconds
+ that the server will allow the client to negotiate \n
+ The default value is 4000"
type: integer
preAllocSize:
- description: "To avoid seeks ZooKeeper allocates space in the transaction log file in blocks of preAllocSize kilobytes \n The default value is 64M"
+ description: "To avoid seeks ZooKeeper allocates space
+ in the transaction log file in blocks of preAllocSize
+ kilobytes \n The default value is 64M"
type: integer
quorumListenOnAllIPs:
- description: "QuorumListenOnAllIPs when set to true the ZooKeeper server will listen for connections from its peers on all available IP addresses, and not only the address configured in the server list of the configuration file. It affects the connections handling the ZAB protocol and the Fast Leader Election protocol. \n The default value is false."
+ description: "QuorumListenOnAllIPs when set to true the
+ ZooKeeper server will listen for connections from its
+ peers on all available IP addresses, and not only the
+ address configured in the server list of the configuration
+ file. It affects the connections handling the ZAB protocol
+ and the Fast Leader Election protocol. \n The default
+ value is false."
type: boolean
snapCount:
- description: "ZooKeeper records its transactions using snapshots and a transaction log The number of transactions recorded in the transaction log before a snapshot can be taken is determined by snapCount \n The default value is 100,000"
+ description: "ZooKeeper records its transactions using
+ snapshots and a transaction log The number of transactions
+ recorded in the transaction log before a snapshot can
+ be taken is determined by snapCount \n The default value
+ is 100,000"
type: integer
snapSizeLimitInKb:
- description: "Snapshot size limit in Kb \n The defult value is 4GB"
+ description: "Snapshot size limit in Kb \n The defult
+ value is 4GB"
type: integer
syncLimit:
- description: "SyncLimit is the amount of time, in ticks, to allow followers to sync with Zookeeper. \n The default value is 2."
+ description: "SyncLimit is the amount of time, in ticks,
+ to allow followers to sync with Zookeeper. \n The default
+ value is 2."
type: integer
tickTime:
- description: "TickTime is the length of a single tick, which is the basic time unit used by Zookeeper, as measured in milliseconds \n The default value is 2000."
+ description: "TickTime is the length of a single tick,
+ which is the basic time unit used by Zookeeper, as measured
+ in milliseconds \n The default value is 2000."
type: integer
type: object
ephemeral:
- description: Ephemeral is the configuration which helps create ephemeral storage At anypoint only one of Persistence or Ephemeral should be present in the manifest
+ description: Ephemeral is the configuration which helps create
+ ephemeral storage At anypoint only one of Persistence or
+ Ephemeral should be present in the manifest
properties:
emptydirvolumesource:
- description: EmptyDirVolumeSource is optional and this will create the emptydir volume It has two parameters Medium and SizeLimit which are optional as well Medium specifies What type of storage medium should back this directory. SizeLimit specifies Total amount of local storage required for this EmptyDir volume.
+ description: EmptyDirVolumeSource is optional and this
+ will create the emptydir volume It has two parameters
+ Medium and SizeLimit which are optional as well Medium
+ specifies What type of storage medium should back this
+ directory. SizeLimit specifies Total amount of local
+ storage required for this EmptyDir volume.
properties:
medium:
- description: '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'
+ description: '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'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
+ description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
@@ -5577,7 +8984,8 @@
imagePullSecret:
type: string
pullPolicy:
- description: PullPolicy describes a policy for if/when to pull a container image
+ description: PullPolicy describes a policy for if/when
+ to pull a container image
type: string
repository:
type: string
@@ -5585,45 +8993,72 @@
type: string
type: object
persistence:
- description: Persistence is the configuration for zookeeper persistent layer. PersistentVolumeClaimSpec and VolumeReclaimPolicy can be specified in here. At anypoint only one of Persistence or Ephemeral should be present in the manifest
+ description: Persistence is the configuration for zookeeper
+ persistent layer. PersistentVolumeClaimSpec and VolumeReclaimPolicy
+ can be specified in here. At anypoint only one of Persistence
+ or Ephemeral should be present in the manifest
properties:
annotations:
additionalProperties:
type: string
- description: Annotations specifies the annotations to attach to pvc the operator creates.
+ description: Annotations specifies the annotations to
+ attach to pvc the operator creates.
type: object
reclaimPolicy:
- description: VolumeReclaimPolicy is a zookeeper operator configuration. If it's set to Delete, the corresponding PVCs will be deleted by the operator when zookeeper cluster is deleted. The default value is Retain.
+ description: VolumeReclaimPolicy is a zookeeper operator
+ configuration. If it's set to Delete, the corresponding
+ PVCs will be deleted by the operator when zookeeper
+ cluster is deleted. The default value is Retain.
enum:
- Retain
- Delete
type: string
spec:
- description: PersistentVolumeClaimSpec is the spec to describe PVC for the container This field is optional. If no PVC is specified default persistentvolume will get created.
+ description: PersistentVolumeClaimSpec is the spec to
+ describe PVC for the container This field is optional.
+ If no PVC is specified default persistentvolume will
+ get created.
properties:
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'
+ description: 'AccessModes contains the desired access
+ modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. 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.'
+ description: 'This field can be used to specify either:
+ * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
+ * An existing PVC (PersistentVolumeClaim) * An existing
+ custom resource that implements data population
+ (Alpha) In order to use custom resource types that
+ implement data population, the AnyVolumeDataSource
+ feature gate must be enabled. 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.'
properties:
apiGroup:
- description: 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.
+ description: 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.
type: string
kind:
- description: Kind is the type of resource being referenced
+ description: Kind is the type of resource being
+ referenced
type: string
name:
- description: Name is the name of resource being referenced
+ description: Name is the name of resource being
+ referenced
type: string
required:
- kind
- name
type: object
resources:
- description: 'Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'Resources represents the minimum resources
+ the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
@@ -5632,7 +9067,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -5641,25 +9077,43 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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. More info:
+ https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
selector:
- description: A label query over volumes to consider for binding.
+ description: A label query over volumes to consider
+ for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label
+ selector requirements. The requirements are
+ ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement is
+ a selector that contains values, a key, and
+ an operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label key that the
+ selector applies to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's
+ relationship to a set of values. Valid
+ operators are In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5671,31 +9125,47 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
storageClassName:
- description: 'Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'Name of the StorageClass required by
+ the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
+ description: volumeMode defines what type of volume
+ is required by the claim. Value of Filesystem is
+ implied when not included in claim spec.
type: string
volumeName:
- description: VolumeName is the binding reference to the PersistentVolume backing this claim.
+ description: VolumeName is the binding reference to
+ the PersistentVolume backing this claim.
type: string
type: object
type: object
readOnlyAcl:
- description: ZooKeeper ACL to use when connecting with ZK for reading operations. This ACL should have READ permission in the given chRoot.
+ description: ZooKeeper ACL to use when connecting with ZK
+ for reading operations. This ACL should have READ permission
+ in the given chRoot.
properties:
passwordKey:
- description: The name of the key in the given secret that contains the ACL password
+ description: The name of the key in the given secret that
+ contains the ACL password
type: string
secret:
- description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
+ description: The name of the Kubernetes Secret that stores
+ the username and password for the ACL. This secret must
+ be in the same namespace as the solrCloud or prometheusExporter
+ is running in.
type: string
usernameKey:
- description: The name of the key in the given secret that contains the ACL username
+ description: The name of the key in the given secret that
+ contains the ACL username
type: string
required:
- passwordKey
@@ -5703,7 +9173,8 @@
- usernameKey
type: object
replicas:
- description: Number of members to create up for the ZK ensemble Defaults to 3
+ description: Number of members to create up for the ZK ensemble
+ Defaults to 3
format: int32
type: integer
zookeeperPodPolicy:
@@ -5713,29 +9184,66 @@
description: The scheduling constraints on pods.
properties:
nodeAffinity:
- description: Describes node affinity scheduling rules for the pod.
+ description: Describes node affinity scheduling rules
+ for the pod.
properties:
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.
+ 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.
items:
- 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).
+ 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).
properties:
preference:
- description: A node selector term, associated with the corresponding weight.
+ description: A node selector term, associated
+ with the corresponding weight.
properties:
matchExpressions:
- description: A list of node selector requirements by node's labels.
+ description: A list of node selector
+ requirements by node's labels.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that
+ the selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's
+ relationship to a set of values.
+ Valid operators are In, NotIn,
+ Exists, DoesNotExist. Gt, and
+ Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5745,18 +9253,38 @@
type: object
type: array
matchFields:
- description: A list of node selector requirements by node's fields.
+ description: A list of node selector
+ requirements by node's fields.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that
+ the selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's
+ relationship to a set of values.
+ Valid operators are In, NotIn,
+ Exists, DoesNotExist. Gt, and
+ Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5767,7 +9295,9 @@
type: array
type: object
weight:
- description: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
+ description: Weight associated with matching
+ the corresponding nodeSelectorTerm, in
+ the range 1-100.
format: int32
type: integer
required:
@@ -5776,26 +9306,57 @@
type: object
type: array
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.
+ 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.
properties:
nodeSelectorTerms:
- description: Required. A list of node selector terms. The terms are ORed.
+ description: Required. A list of node selector
+ terms. The terms are ORed.
items:
- 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.
+ 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.
properties:
matchExpressions:
- description: A list of node selector requirements by node's labels.
+ description: A list of node selector
+ requirements by node's labels.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that
+ the selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's
+ relationship to a set of values.
+ Valid operators are In, NotIn,
+ Exists, DoesNotExist. Gt, and
+ Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5805,18 +9366,38 @@
type: object
type: array
matchFields:
- description: A list of node selector requirements by node's fields.
+ description: A list of node selector
+ requirements by node's fields.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that
+ the selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's
+ relationship to a set of values.
+ Valid operators are In, NotIn,
+ Exists, DoesNotExist. Gt, and
+ Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5832,32 +9413,72 @@
type: object
type: object
podAffinity:
- description: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
+ description: Describes pod affinity scheduling rules
+ (e.g. co-locate this pod in the same node, zone,
+ etc. as some other pod(s)).
properties:
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 has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
+ 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 has
+ pods which matches the corresponding podAffinityTerm;
+ the node(s) with the highest sum are the most
+ preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched
+ WeightedPodAffinityTerm fields are added per-node
+ to find the most preferred node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated with the corresponding weight.
+ description: Required. A pod affinity term,
+ associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set
+ of resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is
+ a list of label selector requirements.
+ The requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector
+ requirement is a selector that
+ contains values, a key, and
+ an operator that relates the
+ key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to
+ a set of values. Valid operators
+ are In, NotIn, Exists and
+ DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5869,22 +9490,44 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which
+ namespaces the labelSelector applies
+ to (matches against); null or empty
+ list means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located
+ (affinity) or not co-located (anti-affinity)
+ with the pods matching the labelSelector
+ in the specified namespaces, where
+ co-located is defined as running on
+ a node whose value of the label with
+ key topologyKey matches that of any
+ node on which any of the selected
+ pods is running. Empty topologyKey
+ is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
+ description: weight associated with matching
+ the corresponding podAffinityTerm, in
+ the range 1-100.
format: int32
type: integer
required:
@@ -5893,26 +9536,61 @@
type: object
type: array
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 a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
+ 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 a pod label update),
+ the system may or may not try to eventually
+ evict the pod from its node. When there are
+ multiple elements, the lists of nodes corresponding
+ to each podAffinityTerm are intersected, i.e.
+ all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
+ description: Defines a set of pods (namely those
+ matching the labelSelector relative to the
+ given namespace(s)) that this pod should be
+ co-located (affinity) or not co-located (anti-affinity)
+ with, where co-located is defined as running
+ on a node whose value of the label with key
+ <topologyKey> matches that of any node on
+ which a pod of the set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of
+ resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The
+ requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a set
+ of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5924,16 +9602,34 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which
+ namespaces the labelSelector applies to
+ (matches against); null or empty list
+ means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located
+ (affinity) or not co-located (anti-affinity)
+ with the pods matching the labelSelector
+ in the specified namespaces, where co-located
+ is defined as running on a node whose
+ value of the label with key topologyKey
+ matches that of any node on which any
+ of the selected pods is running. Empty
+ topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -5941,32 +9637,72 @@
type: array
type: object
podAntiAffinity:
- description: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
+ description: Describes pod anti-affinity scheduling
+ rules (e.g. avoid putting this pod in the same node,
+ zone, etc. as some other pod(s)).
properties:
preferredDuringSchedulingIgnoredDuringExecution:
- description: The scheduler will prefer to schedule pods to nodes that satisfy the anti-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 anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
+ description: The scheduler will prefer to schedule
+ pods to nodes that satisfy the anti-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
+ anti-affinity expressions, etc.), compute a
+ sum by iterating through the elements of this
+ field and adding "weight" to the sum if the
+ node has pods which matches the corresponding
+ podAffinityTerm; the node(s) with the highest
+ sum are the most preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched
+ WeightedPodAffinityTerm fields are added per-node
+ to find the most preferred node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated with the corresponding weight.
+ description: Required. A pod affinity term,
+ associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set
+ of resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is
+ a list of label selector requirements.
+ The requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector
+ requirement is a selector that
+ contains values, a key, and
+ an operator that relates the
+ key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to
+ a set of values. Valid operators
+ are In, NotIn, Exists and
+ DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -5978,22 +9714,44 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which
+ namespaces the labelSelector applies
+ to (matches against); null or empty
+ list means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located
+ (affinity) or not co-located (anti-affinity)
+ with the pods matching the labelSelector
+ in the specified namespaces, where
+ co-located is defined as running on
+ a node whose value of the label with
+ key topologyKey matches that of any
+ node on which any of the selected
+ pods is running. Empty topologyKey
+ is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
+ description: weight associated with matching
+ the corresponding podAffinityTerm, in
+ the range 1-100.
format: int32
type: integer
required:
@@ -6002,26 +9760,61 @@
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
+ description: If the anti-affinity requirements
+ specified by this field are not met at scheduling
+ time, the pod will not be scheduled onto the
+ node. If the anti-affinity requirements specified
+ by this field cease to be met at some point
+ during pod execution (e.g. due to a pod label
+ update), the system may or may not try to eventually
+ evict the pod from its node. When there are
+ multiple elements, the lists of nodes corresponding
+ to each podAffinityTerm are intersected, i.e.
+ all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
+ description: Defines a set of pods (namely those
+ matching the labelSelector relative to the
+ given namespace(s)) that this pod should be
+ co-located (affinity) or not co-located (anti-affinity)
+ with, where co-located is defined as running
+ on a node whose value of the label with key
+ <topologyKey> matches that of any node on
+ which a pod of the set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of
+ resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The
+ requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a set
+ of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -6033,16 +9826,34 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which
+ namespaces the labelSelector applies to
+ (matches against); null or empty list
+ means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located
+ (affinity) or not co-located (anti-affinity)
+ with the pods matching the labelSelector
+ in the specified namespaces, where co-located
+ is defined as running on a node whose
+ value of the label with key topologyKey
+ matches that of any node on which any
+ of the selected pods is running. Empty
+ topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -6053,21 +9864,34 @@
annotations:
additionalProperties:
type: string
- description: Annotations specifies the annotations to attach to zookeeper pods creates.
+ description: Annotations specifies the annotations to
+ attach to zookeeper pods creates.
type: object
env:
- description: List of environment variables to set in the main ZK container.
+ description: List of environment variables to set in the
+ main ZK container.
items:
- description: EnvVar represents an environment variable present in a Container.
+ description: EnvVar represents an environment variable
+ present in a Container.
properties:
name:
- description: Name of the environment variable. Must be a C_IDENTIFIER.
+ description: Name of the environment variable. Must
+ be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME) are
+ expanded using the previous 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.
+ The $(VAR_NAME) syntax can be escaped with a double
+ $$, ie: $$(VAR_NAME). Escaped references will
+ never be expanded, regardless of whether the variable
+ exists or not. Defaults to "".'
type: string
valueFrom:
- description: Source for the environment variable's value. Cannot be used if value is not empty.
+ description: Source for the environment variable's
+ value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -6076,37 +9900,54 @@
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key must be defined
+ description: Specify whether the ConfigMap
+ or its key must be defined
type: boolean
required:
- key
type: object
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.'
+ 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.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema the FieldPath
+ is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to select
+ in the specified API version.
type: string
required:
- fieldPath
type: object
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.'
+ 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.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required for
+ volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output format
+ of the exposed resources, defaults to
+ "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -6116,16 +9957,22 @@
- resource
type: object
secretKeyRef:
- description: Selects a key of a secret in the pod's namespace
+ description: Selects a key of a secret in the
+ pod's namespace
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select
+ from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret
+ or its key must be defined
type: boolean
required:
- key
@@ -6136,19 +9983,26 @@
type: object
type: array
imagePullSecrets:
- description: ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images
+ description: ImagePullSecrets is a list of references
+ to secrets in the same namespace to use for pulling
+ any images
items:
- description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
+ description: LocalObjectReference contains enough information
+ to let you locate the referenced object inside the
+ same namespace.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind,
+ uid?'
type: string
type: object
type: array
labels:
additionalProperties:
type: string
- description: Labels specifies the labels to attach to pods the operator creates for the zookeeper cluster.
+ description: Labels specifies the labels to attach to
+ pods the operator creates for the zookeeper cluster.
type: object
nodeSelector:
additionalProperties:
@@ -6156,7 +10010,8 @@
description: Node Selector to be added on pods.
type: object
resources:
- description: Resources is the resource requirements for the Zookeeper container.
+ description: Resources is the resource requirements for
+ the Zookeeper container.
properties:
limits:
additionalProperties:
@@ -6165,7 +10020,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -6174,68 +10030,132 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
securityContext:
- description: 'SecurityContext specifies the security context for the entire zookeeper pod More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context'
+ description: 'SecurityContext specifies the security context
+ for the entire zookeeper pod More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context'
properties:
fsGroup:
- description: "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume."
+ description: "A special supplemental group that applies
+ to all containers in a pod. Some volume types allow
+ the Kubelet to change the ownership of that volume
+ to be owned by the pod: \n 1. The owning GID will
+ be the FSGroup 2. The setgid bit is set (new files
+ created in the volume will be owned by FSGroup)
+ 3. The permission bits are OR'd with rw-rw---- \n
+ If unset, the Kubelet will not modify the ownership
+ and permissions of any volume."
format: int64
type: integer
fsGroupChangePolicy:
- description: 'fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.'
+ description: 'fsGroupChangePolicy defines behavior
+ of changing ownership and permission of the volume
+ before being exposed inside Pod. This field will
+ only apply to volume types which support fsGroup
+ based ownership(and permissions). It will have no
+ effect on ephemeral volume types such as: secret,
+ configmaps and emptydir. Valid values are "OnRootMismatch"
+ and "Always". If not specified, "Always" is used.'
type: string
runAsGroup:
- description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The GID to run the entrypoint of the
+ container process. Uses runtime default if unset.
+ May also be set in SecurityContext. If set in both
+ SecurityContext and PodSecurityContext, the value
+ specified in SecurityContext takes precedence for
+ that container.
format: int64
type: integer
runAsNonRoot:
- description: 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 SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: 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 SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The UID to run the entrypoint of the
+ container process. Defaults to user specified in
+ image metadata if unspecified. May also be set in
+ SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container.
format: int64
type: integer
seLinuxOptions:
- description: The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The SELinux context to be applied to
+ all containers. If unspecified, the container runtime
+ will allocate a random SELinux context for each
+ container. May also be set in SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence
+ for that container.
properties:
level:
- description: Level is SELinux level label that applies to the container.
+ description: Level is SELinux level label that
+ applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies to the container.
+ description: Role is a SELinux role label that
+ applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies to the container.
+ description: Type is a SELinux type label that
+ applies to the container.
type: string
user:
- description: User is a SELinux user label that applies to the container.
+ description: User is a SELinux user label that
+ applies to the container.
type: string
type: object
seccompProfile:
- description: The seccomp options to use by the containers in this pod.
+ description: The seccomp options to use by the containers
+ in this pod.
properties:
localhostProfile:
- description: 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 only be set if type is "Localhost".
+ description: 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 only be set if type is "Localhost".
type: string
type:
- description: "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."
+ description: "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."
type: string
required:
- type
type: object
supplementalGroups:
- description: A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.
+ description: A list of groups applied to the first
+ process run in each container, in addition to the
+ container's primary GID. If unspecified, no groups
+ will be added to any container.
items:
format: int64
type: integer
type: array
sysctls:
- description: Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.
+ description: Sysctls hold a list of namespaced sysctls
+ used for the pod. Pods with unsupported sysctls
+ (by the container runtime) might fail to launch.
items:
- description: Sysctl defines a kernel parameter to be set
+ description: Sysctl defines a kernel parameter to
+ be set
properties:
name:
description: Name of a property to set
@@ -6249,47 +10169,86 @@
type: object
type: array
windowsOptions:
- description: The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The Windows specific settings applied
+ to all containers. If unspecified, the options within
+ a container's SecurityContext will be used. If set
+ in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence.
properties:
gmsaCredentialSpec:
- description: 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.
+ description: 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.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name
+ of the GMSA credential spec to use.
type: string
runAsUserName:
- description: 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.
+ description: 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.
type: string
type: object
type: object
serviceAccountName:
- description: Optional Service Account to run the zookeeper pods under.
+ description: Optional Service Account to run the zookeeper
+ pods under.
type: string
terminationGracePeriodSeconds:
- description: TerminationGracePeriodSeconds is the amount of time that kubernetes will give for a zookeeper pod instance to shutdown normally. The default value is 30.
+ description: TerminationGracePeriodSeconds is the amount
+ of time that kubernetes will give for a zookeeper pod
+ instance to shutdown normally. The default value is
+ 30.
format: int64
minimum: 0
type: integer
tolerations:
description: Tolerations to be added on pods.
items:
- description: The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
+ description: The pod this Toleration is attached to
+ tolerates any taint that matches the triple <key,value,effect>
+ using the matching operator <operator>.
properties:
effect:
- description: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
+ description: Effect indicates the taint effect to
+ match. Empty means match all taint effects. When
+ specified, allowed values are NoSchedule, PreferNoSchedule
+ and NoExecute.
type: string
key:
- description: Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
+ description: Key is the taint key that the toleration
+ applies to. Empty means match all taint keys.
+ If the key is empty, operator must be Exists;
+ this combination means to match all values and
+ all keys.
type: string
operator:
- description: Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
+ description: Operator represents a key's relationship
+ to the value. Valid operators are Exists and Equal.
+ Defaults to Equal. Exists is equivalent to wildcard
+ for value, so that a pod can tolerate all taints
+ of a particular category.
type: string
tolerationSeconds:
- description: TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
+ description: TolerationSeconds represents the period
+ of time the toleration (which must be of effect
+ NoExecute, otherwise this field is ignored) tolerates
+ the taint. By default, it is not set, which means
+ tolerate the taint forever (do not evict). Zero
+ and negative values will be treated as 0 (evict
+ immediately) by the system.
format: int64
type: integer
value:
- description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
+ description: Value is the taint value the toleration
+ matches to. If the operator is Exists, the value
+ should be empty, otherwise just a regular string.
type: string
type: object
type: array
@@ -6303,22 +10262,30 @@
backupRepositoriesAvailable:
additionalProperties:
type: boolean
- description: BackupRepositoriesAvailable lists the backupRepositories specified in the SolrCloud and whether they are available across all Pods.
+ description: BackupRepositoriesAvailable lists the backupRepositories
+ specified in the SolrCloud and whether they are available across
+ all Pods.
type: object
backupRestoreReady:
- description: BackupRestoreReady announces whether the solrCloud has the backupRestorePVC mounted to all pods and therefore is ready for backups and restores.
+ description: BackupRestoreReady announces whether the solrCloud has
+ the backupRestorePVC mounted to all pods and therefore is ready
+ for backups and restores.
type: boolean
externalCommonAddress:
- description: ExternalCommonAddress is the external common http address for all solr nodes. Will only be provided when an ingressUrl is provided for the cloud
+ description: ExternalCommonAddress is the external common http address
+ for all solr nodes. Will only be provided when an ingressUrl is
+ provided for the cloud
type: string
internalCommonAddress:
- description: InternalCommonAddress is the internal common http address for all solr nodes
+ description: InternalCommonAddress is the internal common http address
+ for all solr nodes
type: string
podSelector:
description: PodSelector for SolrCloud pods, required by the HPA
type: string
readyReplicas:
- description: ReadyReplicas is the number of ready replicas in the cluster
+ description: ReadyReplicas is the number of ready replicas in the
+ cluster
format: int32
type: integer
replicas:
@@ -6326,27 +10293,34 @@
format: int32
type: integer
solrNodes:
- description: SolrNodes contain the statuses of each solr node running in this solr cloud.
+ description: SolrNodes contain the statuses of each solr node running
+ in this solr cloud.
items:
- description: SolrNodeStatus is the status of a solrNode in the cloud, with readiness status and internal and external addresses
+ description: SolrNodeStatus is the status of a solrNode in the cloud,
+ with readiness status and internal and external addresses
properties:
externalAddress:
- description: An address the node can be connected to from outside of the Kube cluster Will only be provided when an ingressUrl is provided for the cloud
+ description: An address the node can be connected to from outside
+ of the Kube cluster Will only be provided when an ingressUrl
+ is provided for the cloud
type: string
internalAddress:
- description: An address the node can be connected to from within the Kube cluster
+ description: An address the node can be connected to from within
+ the Kube cluster
type: string
name:
description: The name of the pod running the node
type: string
nodeName:
- description: The name of the Kubernetes Node which the pod is running on
+ description: The name of the Kubernetes Node which the pod is
+ running on
type: string
ready:
description: Is the node up and running
type: boolean
specUpToDate:
- description: This Solr Node pod is using the latest version of solrcloud pod spec.
+ description: This Solr Node pod is using the latest version
+ of solrcloud pod spec.
type: boolean
version:
description: The version of solr that the node is running
@@ -6361,29 +10335,38 @@
type: object
type: array
targetVersion:
- description: The version of solr that the cloud is meant to be running. Will only be provided when the cloud is migrating between versions
+ description: The version of solr that the cloud is meant to be running.
+ Will only be provided when the cloud is migrating between versions
type: string
upToDateNodes:
- description: UpToDateNodes is the number of Solr Node pods that are running the latest pod spec
+ description: UpToDateNodes is the number of Solr Node pods that are
+ running the latest pod spec
format: int32
type: integer
version:
description: The version of solr that the cloud is running
type: string
zookeeperConnectionInfo:
- description: ZookeeperConnectionInfo is the information on how to connect to the used Zookeeper
+ description: ZookeeperConnectionInfo is the information on how to
+ connect to the used Zookeeper
properties:
acl:
- description: ZooKeeper ACL to use when connecting with ZK. This ACL should have ALL permission in the given chRoot.
+ description: ZooKeeper ACL to use when connecting with ZK. This
+ ACL should have ALL permission in the given chRoot.
properties:
passwordKey:
- description: The name of the key in the given secret that contains the ACL password
+ description: The name of the key in the given secret that
+ contains the ACL password
type: string
secret:
- description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
+ description: The name of the Kubernetes Secret that stores
+ the username and password for the ACL. This secret must
+ be in the same namespace as the solrCloud or prometheusExporter
+ is running in.
type: string
usernameKey:
- description: The name of the key in the given secret that contains the ACL username
+ description: The name of the key in the given secret that
+ contains the ACL username
type: string
required:
- passwordKey
@@ -6394,22 +10377,33 @@
description: The ChRoot to connect solr at
type: string
externalConnectionString:
- description: The connection string to connect to the ensemble from outside of the Kubernetes cluster If external and no internal connection string is provided, the external cnx string will be used as the internal cnx string
+ description: The connection string to connect to the ensemble
+ from outside of the Kubernetes cluster If external and no internal
+ connection string is provided, the external cnx string will
+ be used as the internal cnx string
type: string
internalConnectionString:
- description: The connection string to connect to the ensemble from within the Kubernetes cluster
+ description: The connection string to connect to the ensemble
+ from within the Kubernetes cluster
type: string
readOnlyAcl:
- description: ZooKeeper ACL to use when connecting with ZK for reading operations. This ACL should have READ permission in the given chRoot.
+ description: ZooKeeper ACL to use when connecting with ZK for
+ reading operations. This ACL should have READ permission in
+ the given chRoot.
properties:
passwordKey:
- description: The name of the key in the given secret that contains the ACL password
+ description: The name of the key in the given secret that
+ contains the ACL password
type: string
secret:
- description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
+ description: The name of the Kubernetes Secret that stores
+ the username and password for the ACL. This secret must
+ be in the same namespace as the solrCloud or prometheusExporter
+ is running in.
type: string
usernameKey:
- description: The name of the key in the given secret that contains the ACL username
+ description: The name of the key in the given secret that
+ contains the ACL username
type: string
required:
- passwordKey
@@ -6451,7 +10445,7 @@
annotations:
operator.solr.apache.org/version: v0.7.0-prerelease
argocd.argoproj.io/sync-options: Replace=true
- controller-gen.kubebuilder.io/version: v0.5.0
+ controller-gen.kubebuilder.io/version: v0.6.0
creationTimestamp: null
name: solrprometheusexporters.solr.apache.org
spec:
@@ -6480,13 +10474,18 @@
name: v1beta1
schema:
openAPIV3Schema:
- description: SolrPrometheusExporter is the Schema for the solrprometheusexporters API
+ description: SolrPrometheusExporter is the Schema for the solrprometheusexporters
+ API
properties:
apiVersion:
- description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+ description: 'APIVersion defines the versioned schema of this representation
+ of an object. Servers should convert recognized schemas to the latest
+ internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
- description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+ description: 'Kind is a string value representing the REST resource this
+ object represents. Servers may infer this from the endpoint the client
+ submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
@@ -6494,12 +10493,15 @@
description: SolrPrometheusExporterSpec defines the desired state of SolrPrometheusExporter
properties:
busyBoxImage:
- description: An initContainer is needed to create a wrapper script around the exporter entrypoint when TLS is enabled with the `spec.solrReference.solrTLS.mountedTLSDir` option
+ description: An initContainer is needed to create a wrapper script
+ around the exporter entrypoint when TLS is enabled with the `spec.solrReference.solrTLS.mountedTLSDir`
+ option
properties:
imagePullSecret:
type: string
pullPolicy:
- description: PullPolicy describes a policy for if/when to pull a container image
+ description: PullPolicy describes a policy for if/when to pull
+ a container image
type: string
repository:
type: string
@@ -6507,10 +10509,12 @@
type: string
type: object
customKubeOptions:
- description: Provide custom options for kubernetes objects created for the SolrPrometheusExporter.
+ description: Provide custom options for kubernetes objects created
+ for the SolrPrometheusExporter.
properties:
configMapOptions:
- description: ServiceOptions defines the custom options for the solrPrometheusExporter ConfigMap.
+ description: ServiceOptions defines the custom options for the
+ solrPrometheusExporter ConfigMap.
properties:
annotations:
additionalProperties:
@@ -6523,11 +10527,13 @@
description: Labels to be added for the ConfigMap.
type: object
providedConfigMap:
- description: Name of a user provided ConfigMap in the same namespace containing a custom solr.xml
+ description: Name of a user provided ConfigMap in the same
+ namespace containing a custom solr.xml
type: string
type: object
deploymentOptions:
- description: DeploymentOptions defines the custom options for the solrPrometheusExporter Deployment.
+ description: DeploymentOptions defines the custom options for
+ the solrPrometheusExporter Deployment.
properties:
annotations:
additionalProperties:
@@ -6541,35 +10547,69 @@
type: object
type: object
podOptions:
- description: SolrPodOptions defines the custom options for the solrPrometheusExporter pods.
+ description: SolrPodOptions defines the custom options for the
+ solrPrometheusExporter pods.
properties:
affinity:
description: The scheduling constraints on pods.
properties:
nodeAffinity:
- description: Describes node affinity scheduling rules for the pod.
+ description: Describes node affinity scheduling rules
+ for the pod.
properties:
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.
+ 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.
items:
- 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).
+ 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).
properties:
preference:
- description: A node selector term, associated with the corresponding weight.
+ description: A node selector term, associated
+ with the corresponding weight.
properties:
matchExpressions:
- description: A list of node selector requirements by node's labels.
+ description: A list of node selector requirements
+ by node's labels.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that the
+ selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's relationship
+ to a set of values. Valid operators
+ are In, NotIn, Exists, DoesNotExist.
+ Gt, and Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -6579,18 +10619,35 @@
type: object
type: array
matchFields:
- description: A list of node selector requirements by node's fields.
+ description: A list of node selector requirements
+ by node's fields.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that the
+ selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's relationship
+ to a set of values. Valid operators
+ are In, NotIn, Exists, DoesNotExist.
+ Gt, and Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -6601,7 +10658,9 @@
type: array
type: object
weight:
- description: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
+ description: Weight associated with matching
+ the corresponding nodeSelectorTerm, in the
+ range 1-100.
format: int32
type: integer
required:
@@ -6610,26 +10669,53 @@
type: object
type: array
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.
+ 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.
properties:
nodeSelectorTerms:
- description: Required. A list of node selector terms. The terms are ORed.
+ description: Required. A list of node selector
+ terms. The terms are ORed.
items:
- 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.
+ 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.
properties:
matchExpressions:
- description: A list of node selector requirements by node's labels.
+ description: A list of node selector requirements
+ by node's labels.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that the
+ selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's relationship
+ to a set of values. Valid operators
+ are In, NotIn, Exists, DoesNotExist.
+ Gt, and Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -6639,18 +10725,35 @@
type: object
type: array
matchFields:
- description: A list of node selector requirements by node's fields.
+ description: A list of node selector requirements
+ by node's fields.
items:
- description: A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A node selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: The label key that the selector applies to.
+ description: The label key that the
+ selector applies to.
type: string
operator:
- description: Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
+ description: Represents a key's relationship
+ to a set of values. Valid operators
+ are In, NotIn, Exists, DoesNotExist.
+ Gt, and Lt.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -6666,32 +10769,67 @@
type: object
type: object
podAffinity:
- description: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
+ description: Describes pod affinity scheduling rules (e.g.
+ co-locate this pod in the same node, zone, etc. as some
+ other pod(s)).
properties:
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 has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
+ 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 has pods which matches the corresponding
+ podAffinityTerm; the node(s) with the highest sum
+ are the most preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched WeightedPodAffinityTerm
+ fields are added per-node to find the most preferred
+ node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated with the corresponding weight.
+ description: Required. A pod affinity term,
+ associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of
+ resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The
+ requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a set
+ of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -6703,22 +10841,42 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which
+ namespaces the labelSelector applies to
+ (matches against); null or empty list
+ means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located
+ (affinity) or not co-located (anti-affinity)
+ with the pods matching the labelSelector
+ in the specified namespaces, where co-located
+ is defined as running on a node whose
+ value of the label with key topologyKey
+ matches that of any node on which any
+ of the selected pods is running. Empty
+ topologyKey is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
+ description: weight associated with matching
+ the corresponding podAffinityTerm, in the
+ range 1-100.
format: int32
type: integer
required:
@@ -6727,26 +10885,59 @@
type: object
type: array
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 a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
+ 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 a pod label update), the system may or may
+ not try to eventually evict the pod from its node.
+ When there are multiple elements, the lists of nodes
+ corresponding to each podAffinityTerm are intersected,
+ i.e. all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
+ description: Defines a set of pods (namely those
+ matching the labelSelector relative to the given
+ namespace(s)) that this pod should be co-located
+ (affinity) or not co-located (anti-affinity) with,
+ where co-located is defined as running on a node
+ whose value of the label with key <topologyKey>
+ matches that of any node on which a pod of the
+ set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of resources,
+ in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The requirements
+ are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label key
+ that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a
+ key's relationship to a set of values.
+ Valid operators are In, NotIn, Exists
+ and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -6758,16 +10949,30 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which namespaces
+ the labelSelector applies to (matches against);
+ null or empty list means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity)
+ or not co-located (anti-affinity) with the
+ pods matching the labelSelector in the specified
+ namespaces, where co-located is defined as
+ running on a node whose value of the label
+ with key topologyKey matches that of any node
+ on which any of the selected pods is running.
+ Empty topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -6775,32 +10980,67 @@
type: array
type: object
podAntiAffinity:
- description: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
+ description: Describes pod anti-affinity scheduling rules
+ (e.g. avoid putting this pod in the same node, zone,
+ etc. as some other pod(s)).
properties:
preferredDuringSchedulingIgnoredDuringExecution:
- description: The scheduler will prefer to schedule pods to nodes that satisfy the anti-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 anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
+ description: The scheduler will prefer to schedule
+ pods to nodes that satisfy the anti-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 anti-affinity
+ expressions, etc.), compute a sum by iterating through
+ the elements of this field and adding "weight" to
+ the sum if the node has pods which matches the corresponding
+ podAffinityTerm; the node(s) with the highest sum
+ are the most preferred.
items:
- description: The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
+ description: The weights of all of the matched WeightedPodAffinityTerm
+ fields are added per-node to find the most preferred
+ node(s)
properties:
podAffinityTerm:
- description: Required. A pod affinity term, associated with the corresponding weight.
+ description: Required. A pod affinity term,
+ associated with the corresponding weight.
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of
+ resources, in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The
+ requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to a set
+ of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -6812,22 +11052,42 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which
+ namespaces the labelSelector applies to
+ (matches against); null or empty list
+ means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located
+ (affinity) or not co-located (anti-affinity)
+ with the pods matching the labelSelector
+ in the specified namespaces, where co-located
+ is defined as running on a node whose
+ value of the label with key topologyKey
+ matches that of any node on which any
+ of the selected pods is running. Empty
+ topologyKey is not allowed.
type: string
required:
- topologyKey
type: object
weight:
- description: weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
+ description: weight associated with matching
+ the corresponding podAffinityTerm, in the
+ range 1-100.
format: int32
type: integer
required:
@@ -6836,26 +11096,59 @@
type: object
type: array
requiredDuringSchedulingIgnoredDuringExecution:
- description: If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
+ description: If the anti-affinity requirements specified
+ by this field are not met at scheduling time, the
+ pod will not be scheduled onto the node. If the
+ anti-affinity requirements specified by this field
+ cease to be met at some point during pod execution
+ (e.g. due to a pod label update), the system may
+ or may not try to eventually evict the pod from
+ its node. When there are multiple elements, the
+ lists of nodes corresponding to each podAffinityTerm
+ are intersected, i.e. all terms must be satisfied.
items:
- description: Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
+ description: Defines a set of pods (namely those
+ matching the labelSelector relative to the given
+ namespace(s)) that this pod should be co-located
+ (affinity) or not co-located (anti-affinity) with,
+ where co-located is defined as running on a node
+ whose value of the label with key <topologyKey>
+ matches that of any node on which a pod of the
+ set of pods is running
properties:
labelSelector:
- description: A label query over a set of resources, in this case pods.
+ description: A label query over a set of resources,
+ in this case pods.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list
+ of label selector requirements. The requirements
+ are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement
+ is a selector that contains values,
+ a key, and an operator that relates
+ the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label key
+ that the selector applies to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a
+ key's relationship to a set of values.
+ Valid operators are In, NotIn, Exists
+ and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -6867,16 +11160,30 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
namespaces:
- description: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
+ description: namespaces specifies which namespaces
+ the labelSelector applies to (matches against);
+ null or empty list means "this pod's namespace"
items:
type: string
type: array
topologyKey:
- description: This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.
+ description: This pod should be co-located (affinity)
+ or not co-located (anti-affinity) with the
+ pods matching the labelSelector in the specified
+ namespaces, where co-located is defined as
+ running on a node whose value of the label
+ with key topologyKey matches that of any node
+ on which any of the selected pods is running.
+ Empty topologyKey is not allowed.
type: string
required:
- topologyKey
@@ -6890,7 +11197,9 @@
description: Annotations to be added for pods.
type: object
defaultInitContainerResources:
- description: DefaultInitContainerResources are the resource requirements for the default init container(s) created by the Solr Operator, if any are created.
+ description: DefaultInitContainerResources are the resource
+ requirements for the default init container(s) created by
+ the Solr Operator, if any are created.
properties:
limits:
additionalProperties:
@@ -6899,7 +11208,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount of compute
+ resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -6908,22 +11218,38 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
envVars:
- description: Additional environment variables to pass to the default container.
+ description: Additional environment variables to pass to the
+ default container.
items:
- description: EnvVar represents an environment variable present in a Container.
+ description: EnvVar represents an environment variable present
+ in a Container.
properties:
name:
- description: Name of the environment variable. Must be a C_IDENTIFIER.
+ description: Name of the environment variable. Must
+ be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME) are expanded
+ using the previous 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. The $(VAR_NAME)
+ syntax can be escaped with a double $$, ie: $$(VAR_NAME).
+ Escaped references will never be expanded, regardless
+ of whether the variable exists or not. Defaults to
+ "".'
type: string
valueFrom:
- description: Source for the environment variable's value. Cannot be used if value is not empty.
+ description: Source for the environment variable's value.
+ Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -6932,37 +11258,53 @@
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key must be defined
+ description: Specify whether the ConfigMap or
+ its key must be defined
type: boolean
required:
- key
type: object
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.'
+ 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.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema the FieldPath
+ is written in terms of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to select in
+ the specified API version.
type: string
required:
- fieldPath
type: object
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.'
+ 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.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required for volumes,
+ optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output format of
+ the exposed resources, defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -6972,16 +11314,22 @@
- resource
type: object
secretKeyRef:
- description: Selects a key of a secret in the pod's namespace
+ description: Selects a key of a secret in the pod's
+ namespace
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select
+ from. Must be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its
+ key must be defined
type: boolean
required:
- key
@@ -6992,43 +11340,80 @@
type: object
type: array
imagePullSecrets:
- description: ImagePullSecrets to apply to the pod. These are for init/sidecarContainers in addition to the imagePullSecret defined for the solr image.
+ description: ImagePullSecrets to apply to the pod. These are
+ for init/sidecarContainers in addition to the imagePullSecret
+ defined for the solr image.
items:
- description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
+ description: LocalObjectReference contains enough information
+ to let you locate the referenced object inside the same
+ namespace.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
type: object
type: array
initContainers:
- description: Additional init containers to run in the pod. These will run along with the init container that sets up the "solr.xml".
+ description: Additional init containers to run in the pod.
+ These will run along with the init container that sets up
+ the "solr.xml".
items:
- description: A single application container that you want to run within a pod.
+ description: A single application container that you want
+ to run within a pod.
properties:
args:
- description: 'Arguments to the entrypoint. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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'
+ description: 'Arguments to the entrypoint. The docker
+ 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. The
+ $(VAR_NAME) syntax can be escaped with a double $$,
+ ie: $$(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'
items:
type: string
type: array
command:
- description: 'Entrypoint array. Not executed within a shell. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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'
+ description: 'Entrypoint array. Not executed within
+ a shell. The docker 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. The $(VAR_NAME) syntax
+ can be escaped with a double $$, ie: $$(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'
items:
type: string
type: array
env:
- description: List of environment variables to set in the container. Cannot be updated.
+ description: List of environment variables to set in
+ the container. Cannot be updated.
items:
- description: EnvVar represents an environment variable present in a Container.
+ description: EnvVar represents an environment variable
+ present in a Container.
properties:
name:
- description: Name of the environment variable. Must be a C_IDENTIFIER.
+ description: Name of the environment variable.
+ Must be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previous 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.
+ The $(VAR_NAME) syntax can be escaped with a
+ double $$, ie: $$(VAR_NAME). Escaped references
+ will never be expanded, regardless of whether
+ the variable exists or not. Defaults to "".'
type: string
valueFrom:
- description: Source for the environment variable's value. Cannot be used if value is not empty.
+ description: Source for the environment variable's
+ value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -7037,37 +11422,55 @@
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key must be defined
+ description: Specify whether the ConfigMap
+ or its key must be defined
type: boolean
required:
- key
type: object
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.'
+ 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.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema the
+ FieldPath is written in terms of, defaults
+ to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to select
+ in the specified API version.
type: string
required:
- fieldPath
type: object
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.'
+ 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.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required
+ for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output format
+ of the exposed resources, defaults to
+ "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -7077,16 +11480,23 @@
- resource
type: object
secretKeyRef:
- description: Selects a key of a secret in the pod's namespace
+ description: Selects a key of a secret in
+ the pod's namespace
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to
+ select from. Must be a valid secret
+ key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret
+ or its key must be defined
type: boolean
required:
- key
@@ -7097,66 +11507,112 @@
type: object
type: array
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.
+ 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.
items:
- description: EnvFromSource represents the source of a set of ConfigMaps
+ description: EnvFromSource represents the source of
+ a set of ConfigMaps
properties:
configMapRef:
description: The ConfigMap to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap must be defined
+ description: Specify whether the ConfigMap
+ must be defined
type: boolean
type: object
prefix:
- description: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ description: An optional identifier to prepend
+ to each key in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
description: The Secret to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret must be defined
+ description: Specify whether the Secret must
+ be defined
type: boolean
type: object
type: object
type: array
image:
- description: 'Docker 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.'
+ description: 'Docker 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.'
type: string
imagePullPolicy:
- description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
+ description: 'Image pull policy. One of Always, Never,
+ IfNotPresent. Defaults to Always if :latest tag is
+ specified, or IfNotPresent otherwise. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
+ description: Actions that the management system should
+ take in response to container lifecycle events. Cannot
+ be updated.
properties:
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following
+ should be specified. Exec specifies the action
+ to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
+ "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the
+ request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -7170,58 +11626,99 @@
type: object
type: array
path:
- description: Path to access on the HTTP server.
+ description: Path to access on the HTTP
+ server.
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action
+ involving a TCP port. TCP hooks not yet supported
+ TODO: implement a realistic TCP lifecycle
+ hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
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 reason for termination is passed to the handler. The Pod''s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period. 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'
+ 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 reason for termination is passed
+ to the handler. The Pod''s termination grace period
+ countdown begins before the PreStop hooked is
+ executed. Regardless of the outcome of the handler,
+ the container will eventually terminate within
+ the Pod''s termination grace period. 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following
+ should be specified. Exec specifies the action
+ to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
+ "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the
+ request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -7235,31 +11732,43 @@
type: object
type: array
path:
- description: Path to access on the HTTP server.
+ description: Path to access on the HTTP
+ server.
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action
+ involving a TCP port. TCP hooks not yet supported
+ TODO: implement a realistic TCP lifecycle
+ hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
@@ -7267,31 +11776,49 @@
type: object
type: object
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -7311,71 +11838,109 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
name:
- description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
+ description: Name of the container specified as a DNS_LABEL.
+ Each container in a pod must have a unique name (DNS_LABEL).
+ Cannot be updated.
type: string
ports:
- description: List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. Cannot be updated.
+ description: List of ports to expose from the container.
+ Exposing a port here gives the system additional information
+ about the network connections a container uses, but
+ is primarily informational. 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. Cannot be updated.
items:
- description: ContainerPort represents a network port in a single container.
+ description: ContainerPort represents a network port
+ in a single container.
properties:
containerPort:
- description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's
+ IP address. This must be a valid port number,
+ 0 < x < 65536.
format: int32
type: integer
hostIP:
- description: What host IP to bind the external port to.
+ description: What host IP to bind the external
+ port to.
type: string
hostPort:
- description: 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 do not need this.
+ description: 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
+ do not need this.
format: int32
type: integer
name:
- description: 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.
+ description: 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.
type: string
protocol:
default: TCP
- description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP,
+ or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -7386,31 +11951,49 @@
- protocol
x-kubernetes-list-type: map
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -7430,48 +12013,66 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
resources:
- description: 'Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Compute Resources required by this container.
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
properties:
limits:
additionalProperties:
@@ -7480,7 +12081,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -7489,119 +12091,221 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
securityContext:
- description: 'Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
+ description: 'Security options the pod should run with.
+ More info: https://kubernetes.io/docs/concepts/policy/security-context/
+ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: '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'
+ description: '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'
type: boolean
capabilities:
- description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
+ description: The capabilities to add/drop when running
+ containers. Defaults to the default set of capabilities
+ granted by the container runtime.
properties:
add:
description: Added capabilities
items:
- description: Capability represent POSIX capabilities type
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
drop:
description: Removed capabilities
items:
- description: Capability represent POSIX capabilities type
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
type: object
privileged:
- description: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
+ description: Run container in privileged mode. Processes
+ in privileged containers are essentially equivalent
+ to root on the host. Defaults to false.
type: boolean
procMount:
- description: 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.
+ description: 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.
type: string
readOnlyRootFilesystem:
- description: Whether this container has a read-only root filesystem. Default is false.
+ description: Whether this container has a read-only
+ root filesystem. Default is false.
type: boolean
runAsGroup:
- description: 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.
+ description: 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.
format: int64
type: integer
runAsNonRoot:
- description: 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.
+ description: 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.
type: boolean
runAsUser:
- description: 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.
+ description: 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.
format: int64
type: integer
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.
+ 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.
properties:
level:
- description: Level is SELinux level label that applies to the container.
+ description: Level is SELinux level label that
+ applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies to the container.
+ description: Role is a SELinux role label that
+ applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies to the container.
+ description: Type is a SELinux type label that
+ applies to the container.
type: string
user:
- description: User is a SELinux user label that applies to the container.
+ description: User is a SELinux user label that
+ applies to the container.
type: string
type: object
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.
+ 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.
properties:
localhostProfile:
- description: 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 only be set if type is "Localhost".
+ description: 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 only be set if type is "Localhost".
type: string
type:
- description: "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."
+ description: "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."
type: string
required:
- type
type: object
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.
+ 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.
properties:
gmsaCredentialSpec:
- description: 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.
+ description: 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.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name
+ of the GMSA credential spec to use.
type: string
runAsUserName:
- description: 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.
+ description: 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.
type: string
type: object
type: object
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -7621,71 +12325,124 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
stdin:
- description: 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.
+ description: 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.
type: boolean
stdinOnce:
- description: 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
+ description: 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
type: boolean
terminationMessagePath:
- description: 'Optional: Path at which the file to which the container''s termination message will be written is mounted into the container''s filesystem. 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.'
+ description: 'Optional: Path at which the file to which
+ the container''s termination message will be written
+ is mounted into the container''s filesystem. 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.'
type: string
terminationMessagePolicy:
- description: 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.
+ description: 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.
type: string
tty:
- description: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be true.
+ Default is false.
type: boolean
volumeDevices:
- description: volumeDevices is the list of block devices to be used by the container.
+ description: volumeDevices is the list of block devices
+ to be used by the container.
items:
- description: volumeDevice describes a mapping of a raw block device within a container.
+ description: volumeDevice describes a mapping of a
+ raw block device within a container.
properties:
devicePath:
- description: devicePath is the path inside of the container that the device will be mapped to.
+ description: devicePath is the path inside of
+ the container that the device will be mapped
+ to.
type: string
name:
- description: name must match the name of a persistentVolumeClaim in the pod
+ description: name must match the name of a persistentVolumeClaim
+ in the pod
type: string
required:
- devicePath
@@ -7693,27 +12450,44 @@
type: object
type: array
volumeMounts:
- description: Pod volumes to mount into the container's filesystem. Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
- description: VolumeMount describes a mounting of a Volume within a container.
+ description: VolumeMount describes a mounting of a
+ Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume should be mounted. Must not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: 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.
+ description: 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.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which
+ the container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: 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.
+ description: 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.
type: string
required:
- mountPath
@@ -7721,7 +12495,10 @@
type: object
type: array
workingDir:
- description: 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.
+ description: 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.
type: string
required:
- name
@@ -7736,27 +12513,45 @@
description: Lifecycle for the main container
properties:
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request to
+ perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -7776,52 +12571,85 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the
+ host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to,
+ defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
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 reason for termination is passed to the handler. The Pod''s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period. 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'
+ 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 reason for termination
+ is passed to the handler. The Pod''s termination grace
+ period countdown begins before the PreStop hooked is
+ executed. Regardless of the outcome of the handler,
+ the container will eventually terminate within the Pod''s
+ termination grace period. 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request to
+ perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -7841,25 +12669,33 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the
+ host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to,
+ defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
@@ -7870,28 +12706,42 @@
description: Liveness probe parameters
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe
+ to be considered failed after having succeeded. Defaults
+ to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults to
+ the pod IP. You probably want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -7911,43 +12761,59 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host.
+ Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe.
+ Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults
+ to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
@@ -7957,64 +12823,122 @@
description: Node Selector to be added for the StatefulSet.
type: object
podSecurityContext:
- description: PodSecurityContext is the security context for the pod.
+ description: PodSecurityContext is the security context for
+ the pod.
properties:
fsGroup:
- description: "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume."
+ description: "A special supplemental group that applies
+ to all containers in a pod. Some volume types allow
+ the Kubelet to change the ownership of that volume to
+ be owned by the pod: \n 1. The owning GID will be the
+ FSGroup 2. The setgid bit is set (new files created
+ in the volume will be owned by FSGroup) 3. The permission
+ bits are OR'd with rw-rw---- \n If unset, the Kubelet
+ will not modify the ownership and permissions of any
+ volume."
format: int64
type: integer
fsGroupChangePolicy:
- description: 'fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.'
+ description: 'fsGroupChangePolicy defines behavior of
+ changing ownership and permission of the volume before
+ being exposed inside Pod. This field will only apply
+ to volume types which support fsGroup based ownership(and
+ permissions). It will have no effect on ephemeral volume
+ types such as: secret, configmaps and emptydir. Valid
+ values are "OnRootMismatch" and "Always". If not specified,
+ "Always" is used.'
type: string
runAsGroup:
- description: The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The GID to run the entrypoint of the container
+ process. Uses runtime default if unset. May also be
+ set in SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container.
format: int64
type: integer
runAsNonRoot:
- description: 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 SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: 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 SecurityContext. If set
+ in both SecurityContext and PodSecurityContext, the
+ value specified in SecurityContext takes precedence.
type: boolean
runAsUser:
- description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The UID to run the entrypoint of the container
+ process. Defaults to user specified in image metadata
+ if unspecified. May also be set in SecurityContext. If
+ set in both SecurityContext and PodSecurityContext,
+ the value specified in SecurityContext takes precedence
+ for that container.
format: int64
type: integer
seLinuxOptions:
- description: The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
+ description: The SELinux context to be applied to all
+ containers. If unspecified, the container runtime will
+ allocate a random SELinux context for each container. May
+ also be set in SecurityContext. If set in both SecurityContext
+ and PodSecurityContext, the value specified in SecurityContext
+ takes precedence for that container.
properties:
level:
- description: Level is SELinux level label that applies to the container.
+ description: Level is SELinux level label that applies
+ to the container.
type: string
role:
- description: Role is a SELinux role label that applies to the container.
+ description: Role is a SELinux role label that applies
+ to the container.
type: string
type:
- description: Type is a SELinux type label that applies to the container.
+ description: Type is a SELinux type label that applies
+ to the container.
type: string
user:
- description: User is a SELinux user label that applies to the container.
+ description: User is a SELinux user label that applies
+ to the container.
type: string
type: object
seccompProfile:
- description: The seccomp options to use by the containers in this pod.
+ description: The seccomp options to use by the containers
+ in this pod.
properties:
localhostProfile:
- description: 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 only be set if type is "Localhost".
+ description: 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 only be
+ set if type is "Localhost".
type: string
type:
- description: "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."
+ description: "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."
type: string
required:
- type
type: object
supplementalGroups:
- description: A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.
+ description: A list of groups applied to the first process
+ run in each container, in addition to the container's
+ primary GID. If unspecified, no groups will be added
+ to any container.
items:
format: int64
type: integer
type: array
sysctls:
- description: Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.
+ description: Sysctls hold a list of namespaced sysctls
+ used for the pod. Pods with unsupported sysctls (by
+ the container runtime) might fail to launch.
items:
- description: Sysctl defines a kernel parameter to be set
+ description: Sysctl defines a kernel parameter to be
+ set
properties:
name:
description: Name of a property to set
@@ -8028,16 +12952,29 @@
type: object
type: array
windowsOptions:
- description: The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+ description: The Windows specific settings applied to
+ all containers. If unspecified, the options within a
+ container's SecurityContext will be used. If set in
+ both SecurityContext and PodSecurityContext, the value
+ specified in SecurityContext takes precedence.
properties:
gmsaCredentialSpec:
- description: 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.
+ description: 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.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name of
+ the GMSA credential spec to use.
type: string
runAsUserName:
- description: 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.
+ description: 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.
type: string
type: object
type: object
@@ -8048,28 +12985,42 @@
description: Readiness probe parameters
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe
+ to be considered failed after having succeeded. Defaults
+ to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults to
+ the pod IP. You probably want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -8089,48 +13040,65 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host.
+ Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe.
+ Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults
+ to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
resources:
- description: Resources is the resource requirements for the default container.
+ description: Resources is the resource requirements for the
+ default container.
properties:
limits:
additionalProperties:
@@ -8139,7 +13107,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount of compute
+ resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -8148,40 +13117,75 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
serviceAccountName:
description: Optional Service Account to run the pod under.
type: string
sidecarContainers:
- description: Sidecar containers to run in the pod. These are in addition to the Solr Container
+ description: Sidecar containers to run in the pod. These are
+ in addition to the Solr Container
items:
- description: A single application container that you want to run within a pod.
+ description: A single application container that you want
+ to run within a pod.
properties:
args:
- description: 'Arguments to the entrypoint. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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'
+ description: 'Arguments to the entrypoint. The docker
+ 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. The
+ $(VAR_NAME) syntax can be escaped with a double $$,
+ ie: $$(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'
items:
type: string
type: array
command:
- description: 'Entrypoint array. Not executed within a shell. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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'
+ description: 'Entrypoint array. Not executed within
+ a shell. The docker 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. The $(VAR_NAME) syntax
+ can be escaped with a double $$, ie: $$(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'
items:
type: string
type: array
env:
- description: List of environment variables to set in the container. Cannot be updated.
+ description: List of environment variables to set in
+ the container. Cannot be updated.
items:
- description: EnvVar represents an environment variable present in a Container.
+ description: EnvVar represents an environment variable
+ present in a Container.
properties:
name:
- description: Name of the environment variable. Must be a C_IDENTIFIER.
+ description: Name of the environment variable.
+ Must be a C_IDENTIFIER.
type: string
value:
- description: 'Variable references $(VAR_NAME) are expanded using the previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".'
+ description: 'Variable references $(VAR_NAME)
+ are expanded using the previous 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.
+ The $(VAR_NAME) syntax can be escaped with a
+ double $$, ie: $$(VAR_NAME). Escaped references
+ will never be expanded, regardless of whether
+ the variable exists or not. Defaults to "".'
type: string
valueFrom:
- description: Source for the environment variable's value. Cannot be used if value is not empty.
+ description: Source for the environment variable's
+ value. Cannot be used if value is not empty.
properties:
configMapKeyRef:
description: Selects a key of a ConfigMap.
@@ -8190,37 +13194,55 @@
description: The key to select.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its key must be defined
+ description: Specify whether the ConfigMap
+ or its key must be defined
type: boolean
required:
- key
type: object
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.'
+ 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.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema the
+ FieldPath is written in terms of, defaults
+ to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to select
+ in the specified API version.
type: string
required:
- fieldPath
type: object
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.'
+ 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.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required
+ for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output format
+ of the exposed resources, defaults to
+ "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
@@ -8230,16 +13252,23 @@
- resource
type: object
secretKeyRef:
- description: Selects a key of a secret in the pod's namespace
+ description: Selects a key of a secret in
+ the pod's namespace
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to
+ select from. Must be a valid secret
+ key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret
+ or its key must be defined
type: boolean
required:
- key
@@ -8250,66 +13279,112 @@
type: object
type: array
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.
+ 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.
items:
- description: EnvFromSource represents the source of a set of ConfigMaps
+ description: EnvFromSource represents the source of
+ a set of ConfigMaps
properties:
configMapRef:
description: The ConfigMap to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap must be defined
+ description: Specify whether the ConfigMap
+ must be defined
type: boolean
type: object
prefix:
- description: An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ description: An optional identifier to prepend
+ to each key in the ConfigMap. Must be a C_IDENTIFIER.
type: string
secretRef:
description: The Secret to select from
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret must be defined
+ description: Specify whether the Secret must
+ be defined
type: boolean
type: object
type: object
type: array
image:
- description: 'Docker 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.'
+ description: 'Docker 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.'
type: string
imagePullPolicy:
- description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
+ description: 'Image pull policy. One of Always, Never,
+ IfNotPresent. Defaults to Always if :latest tag is
+ specified, or IfNotPresent otherwise. Cannot be updated.
+ More info: https://kubernetes.io/docs/concepts/containers/images#updating-images'
type: string
lifecycle:
- description: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
+ description: Actions that the management system should
+ take in response to container lifecycle events. Cannot
+ be updated.
properties:
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following
+ should be specified. Exec specifies the action
+ to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
+ "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the
+ request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -8323,58 +13398,99 @@
type: object
type: array
path:
- description: Path to access on the HTTP server.
+ description: Path to access on the HTTP
+ server.
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action
+ involving a TCP port. TCP hooks not yet supported
+ TODO: implement a realistic TCP lifecycle
+ hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
type: object
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 reason for termination is passed to the handler. The Pod''s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod''s termination grace period. 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'
+ 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 reason for termination is passed
+ to the handler. The Pod''s termination grace period
+ countdown begins before the PreStop hooked is
+ executed. Regardless of the outcome of the handler,
+ the container will eventually terminate within
+ the Pod''s termination grace period. 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following
+ should be specified. Exec specifies the action
+ to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set
+ "Host" in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the
+ request. HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -8388,31 +13504,43 @@
type: object
type: array
path:
- description: Path to access on the HTTP server.
+ description: Path to access on the HTTP
+ server.
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting
+ to the host. Defaults to HTTP.
type: string
required:
- port
type: object
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action
+ involving a TCP port. TCP hooks not yet supported
+ TODO: implement a realistic TCP lifecycle
+ hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
@@ -8420,31 +13548,49 @@
type: object
type: object
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -8464,71 +13610,109 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
name:
- description: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
+ description: Name of the container specified as a DNS_LABEL.
+ Each container in a pod must have a unique name (DNS_LABEL).
+ Cannot be updated.
type: string
ports:
- description: List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. 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. Cannot be updated.
+ description: List of ports to expose from the container.
+ Exposing a port here gives the system additional information
+ about the network connections a container uses, but
+ is primarily informational. 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. Cannot be updated.
items:
- description: ContainerPort represents a network port in a single container.
+ description: ContainerPort represents a network port
+ in a single container.
properties:
containerPort:
- description: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
+ description: Number of port to expose on the pod's
+ IP address. This must be a valid port number,
+ 0 < x < 65536.
format: int32
type: integer
hostIP:
- description: What host IP to bind the external port to.
+ description: What host IP to bind the external
+ port to.
type: string
hostPort:
- description: 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 do not need this.
+ description: 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
+ do not need this.
format: int32
type: integer
name:
- description: 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.
+ description: 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.
type: string
protocol:
default: TCP
- description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
+ description: Protocol for port. Must be UDP, TCP,
+ or SCTP. Defaults to "TCP".
type: string
required:
- containerPort
@@ -8539,31 +13723,49 @@
- protocol
x-kubernetes-list-type: map
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -8583,48 +13785,66 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
resources:
- description: 'Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Compute Resources required by this container.
+ Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
properties:
limits:
additionalProperties:
@@ -8633,7 +13853,8 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the maximum amount
+ of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -8642,119 +13863,221 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
securityContext:
- description: 'Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
+ description: 'Security options the pod should run with.
+ More info: https://kubernetes.io/docs/concepts/policy/security-context/
+ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/'
properties:
allowPrivilegeEscalation:
- description: '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'
+ description: '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'
type: boolean
capabilities:
- description: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
+ description: The capabilities to add/drop when running
+ containers. Defaults to the default set of capabilities
+ granted by the container runtime.
properties:
add:
description: Added capabilities
items:
- description: Capability represent POSIX capabilities type
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
drop:
description: Removed capabilities
items:
- description: Capability represent POSIX capabilities type
+ description: Capability represent POSIX capabilities
+ type
type: string
type: array
type: object
privileged:
- description: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
+ description: Run container in privileged mode. Processes
+ in privileged containers are essentially equivalent
+ to root on the host. Defaults to false.
type: boolean
procMount:
- description: 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.
+ description: 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.
type: string
readOnlyRootFilesystem:
- description: Whether this container has a read-only root filesystem. Default is false.
+ description: Whether this container has a read-only
+ root filesystem. Default is false.
type: boolean
runAsGroup:
- description: 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.
+ description: 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.
format: int64
type: integer
runAsNonRoot:
- description: 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.
+ description: 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.
type: boolean
runAsUser:
- description: 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.
+ description: 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.
format: int64
type: integer
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.
+ 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.
properties:
level:
- description: Level is SELinux level label that applies to the container.
+ description: Level is SELinux level label that
+ applies to the container.
type: string
role:
- description: Role is a SELinux role label that applies to the container.
+ description: Role is a SELinux role label that
+ applies to the container.
type: string
type:
- description: Type is a SELinux type label that applies to the container.
+ description: Type is a SELinux type label that
+ applies to the container.
type: string
user:
- description: User is a SELinux user label that applies to the container.
+ description: User is a SELinux user label that
+ applies to the container.
type: string
type: object
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.
+ 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.
properties:
localhostProfile:
- description: 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 only be set if type is "Localhost".
+ description: 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 only be set if type is "Localhost".
type: string
type:
- description: "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."
+ description: "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."
type: string
required:
- type
type: object
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.
+ 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.
properties:
gmsaCredentialSpec:
- description: 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.
+ description: 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.
type: string
gmsaCredentialSpecName:
- description: GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ description: GMSACredentialSpecName is the name
+ of the GMSA credential spec to use.
type: string
runAsUserName:
- description: 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.
+ description: 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.
type: string
type: object
type: object
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'
+ 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'
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the
+ probe to be considered failed after having succeeded.
+ Defaults to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
- description: HTTPGet specifies the http request to perform.
+ description: HTTPGet specifies the http request
+ to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults
+ to the pod IP. You probably want to set "Host"
+ in httpHeaders instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom
+ header to be used in HTTP probes
properties:
name:
description: The header field name
@@ -8774,71 +14097,124 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to
+ the host. Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the
+ probe. Default to 10 seconds. Minimum value is
+ 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO:
+ implement a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect
+ to, defaults to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
stdin:
- description: 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.
+ description: 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.
type: boolean
stdinOnce:
- description: 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
+ description: 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
type: boolean
terminationMessagePath:
- description: 'Optional: Path at which the file to which the container''s termination message will be written is mounted into the container''s filesystem. 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.'
+ description: 'Optional: Path at which the file to which
+ the container''s termination message will be written
+ is mounted into the container''s filesystem. 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.'
type: string
terminationMessagePolicy:
- description: 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.
+ description: 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.
type: string
tty:
- description: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
+ description: Whether this container should allocate
+ a TTY for itself, also requires 'stdin' to be true.
+ Default is false.
type: boolean
volumeDevices:
- description: volumeDevices is the list of block devices to be used by the container.
+ description: volumeDevices is the list of block devices
+ to be used by the container.
items:
- description: volumeDevice describes a mapping of a raw block device within a container.
+ description: volumeDevice describes a mapping of a
+ raw block device within a container.
properties:
devicePath:
- description: devicePath is the path inside of the container that the device will be mapped to.
+ description: devicePath is the path inside of
+ the container that the device will be mapped
+ to.
type: string
name:
- description: name must match the name of a persistentVolumeClaim in the pod
+ description: name must match the name of a persistentVolumeClaim
+ in the pod
type: string
required:
- devicePath
@@ -8846,27 +14222,44 @@
type: object
type: array
volumeMounts:
- description: Pod volumes to mount into the container's filesystem. Cannot be updated.
+ description: Pod volumes to mount into the container's
+ filesystem. Cannot be updated.
items:
- description: VolumeMount describes a mounting of a Volume within a container.
+ description: VolumeMount describes a mounting of a
+ Volume within a container.
properties:
mountPath:
- description: Path within the container at which the volume should be mounted. Must not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: 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.
+ description: 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.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which
+ the container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: 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.
+ description: 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.
type: string
required:
- mountPath
@@ -8874,7 +14267,10 @@
type: object
type: array
workingDir:
- description: 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.
+ description: 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.
type: string
required:
- name
@@ -8884,28 +14280,42 @@
description: Startup probe parameters
properties:
exec:
- description: One and only one of the following should be specified. Exec specifies the action to take.
+ description: One and only one of the following should
+ be specified. Exec specifies the action to take.
properties:
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.
+ 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.
items:
type: string
type: array
type: object
failureThreshold:
- description: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+ description: Minimum consecutive failures for the probe
+ to be considered failed after having succeeded. Defaults
+ to 3. Minimum value is 1.
format: int32
type: integer
httpGet:
description: HTTPGet specifies the http request to perform.
properties:
host:
- description: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
+ description: Host name to connect to, defaults to
+ the pod IP. You probably want to set "Host" in httpHeaders
+ instead.
type: string
httpHeaders:
- description: Custom headers to set in the request. HTTP allows repeated headers.
+ description: Custom headers to set in the request.
+ HTTP allows repeated headers.
items:
- description: HTTPHeader describes a custom header to be used in HTTP probes
+ description: HTTPHeader describes a custom header
+ to be used in HTTP probes
properties:
name:
description: The header field name
@@ -8925,95 +14335,149 @@
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
scheme:
- description: Scheme to use for connecting to the host. Defaults to HTTP.
+ description: Scheme to use for connecting to the host.
+ Defaults to HTTP.
type: string
required:
- port
type: object
initialDelaySeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
periodSeconds:
- description: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+ description: How often (in seconds) to perform the probe.
+ Default to 10 seconds. Minimum value is 1.
format: int32
type: integer
successThreshold:
- description: 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.
+ description: 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.
format: int32
type: integer
tcpSocket:
- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook'
+ description: 'TCPSocket specifies an action involving
+ a TCP port. TCP hooks not yet supported TODO: implement
+ a realistic TCP lifecycle hook'
properties:
host:
- description: 'Optional: Host name to connect to, defaults to the pod IP.'
+ description: 'Optional: Host name to connect to, defaults
+ to the pod IP.'
type: string
port:
anyOf:
- type: integer
- type: string
- description: 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.
+ description: 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.
x-kubernetes-int-or-string: true
required:
- port
type: object
timeoutSeconds:
- description: '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'
+ description: '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'
format: int32
type: integer
type: object
terminationGracePeriodSeconds:
- description: Optional duration in seconds the pod needs to terminate gracefully.
+ description: Optional duration in seconds the pod needs to
+ terminate gracefully.
format: int64
minimum: 10
type: integer
tolerations:
description: Tolerations to be added for the StatefulSet.
items:
- description: The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
+ description: The pod this Toleration is attached to tolerates
+ any taint that matches the triple <key,value,effect> using
+ the matching operator <operator>.
properties:
effect:
- description: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
+ description: Effect indicates the taint effect to match.
+ Empty means match all taint effects. When specified,
+ allowed values are NoSchedule, PreferNoSchedule and
+ NoExecute.
type: string
key:
- description: Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
+ description: Key is the taint key that the toleration
+ applies to. Empty means match all taint keys. If the
+ key is empty, operator must be Exists; this combination
+ means to match all values and all keys.
type: string
operator:
- description: Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
+ description: Operator represents a key's relationship
+ to the value. Valid operators are Exists and Equal.
+ Defaults to Equal. Exists is equivalent to wildcard
+ for value, so that a pod can tolerate all taints of
+ a particular category.
type: string
tolerationSeconds:
- description: TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
+ description: TolerationSeconds represents the period
+ of time the toleration (which must be of effect NoExecute,
+ otherwise this field is ignored) tolerates the taint.
+ By default, it is not set, which means tolerate the
+ taint forever (do not evict). Zero and negative values
+ will be treated as 0 (evict immediately) by the system.
format: int64
type: integer
value:
- description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
+ description: Value is the taint value the toleration
+ matches to. If the operator is Exists, the value should
+ be empty, otherwise just a regular string.
type: string
type: object
type: array
topologySpreadConstraints:
- description: "Optional PodSpreadTopologyConstraints to use when scheduling pods. More information here: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ \n Note: There is no need to provide a \"labelSelector\", as the operator will inject the labels for you if not provided."
+ description: "Optional PodSpreadTopologyConstraints to use
+ when scheduling pods. More information here: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
+ \n Note: There is no need to provide a \"labelSelector\",
+ as the operator will inject the labels for you if not provided."
items:
- description: TopologySpreadConstraint specifies how to spread matching pods among the given topology.
+ description: TopologySpreadConstraint specifies how to spread
+ matching pods among the given topology.
properties:
labelSelector:
- description: LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.
+ description: LabelSelector is used to find matching
+ pods. Pods that match this label selector are counted
+ to determine the number of pods in their corresponding
+ topology domain.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is a list of label
+ selector requirements. The requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector requirement is a
+ selector that contains values, a key, and an
+ operator that relates the key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label key that the
+ selector applies to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents a key's relationship
+ to a set of values. Valid operators are
+ In, NotIn, Exists and DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -9025,18 +14489,59 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
maxSkew:
- description: 'MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It''s a required field. Default value is 1 and 0 is not allowed.'
+ description: 'MaxSkew describes the degree to which
+ pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`,
+ it is the maximum permitted difference between the
+ number of matching pods in the target topology and
+ the global minimum. For example, in a 3-zone cluster,
+ MaxSkew is set to 1, and pods with the same labelSelector
+ spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | |
+ - if MaxSkew is 1, incoming pod can only be scheduled
+ to zone3 to become 1/1/1; scheduling it onto zone1(zone2)
+ would make the ActualSkew(2-0) on zone1(zone2) violate
+ MaxSkew(1). - if MaxSkew is 2, incoming pod can be
+ scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`,
+ it is used to give higher precedence to topologies
+ that satisfy it. It''s a required field. Default value
+ is 1 and 0 is not allowed.'
format: int32
type: integer
topologyKey:
- description: TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. It's a required field.
+ description: TopologyKey is the key of node labels.
+ Nodes that have a label with this key and identical
+ values are considered to be in the same topology.
+ We consider each <key, value> as a "bucket", and try
+ to put balanced number of pods into each bucket. It's
+ a required field.
type: string
whenUnsatisfiable:
- description: 'WhenUnsatisfiable indicates how to deal with a pod if it doesn''t satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won''t make it *more* imbalanced. It''s a required field.'
+ description: 'WhenUnsatisfiable indicates how to deal
+ with a pod if it doesn''t satisfy the spread constraint.
+ - DoNotSchedule (default) tells the scheduler not
+ to schedule it. - ScheduleAnyway tells the scheduler
+ to schedule the pod in any location, but giving
+ higher precedence to topologies that would help reduce
+ the skew. A constraint is considered "Unsatisfiable"
+ for an incoming pod if and only if every possible
+ node assigment for that pod would violate "MaxSkew"
+ on some topology. For example, in a 3-zone cluster,
+ MaxSkew is set to 1, and pods with the same labelSelector
+ spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P
+ | P | P | If WhenUnsatisfiable is set to DoNotSchedule,
+ incoming pod can only be scheduled to zone2(zone3)
+ to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3)
+ satisfies MaxSkew(1). In other words, the cluster
+ can still be imbalanced, but scheduler won''t make
+ it *more* imbalanced. It''s a required field.'
type: string
required:
- maxSkew
@@ -9049,30 +14554,49 @@
- whenUnsatisfiable
x-kubernetes-list-type: map
volumes:
- description: Additional non-data volumes to load into the default container.
+ description: Additional non-data volumes to load into the
+ default container.
items:
- description: AdditionalVolume provides information on additional volumes that should be loaded into pods
+ description: AdditionalVolume provides information on additional
+ volumes that should be loaded into pods
properties:
defaultContainerMount:
- description: DefaultContainerMount defines how to mount this volume into the default container. If this volume is to be used only with sidecar or non-default init containers, then this option is not necessary.
+ description: DefaultContainerMount defines how to mount
+ this volume into the default container. If this volume
+ is to be used only with sidecar or non-default init
+ containers, then this option is not necessary.
properties:
mountPath:
- description: Path within the container at which the volume should be mounted. Must not contain ':'.
+ description: Path within the container at which
+ the volume should be mounted. Must not contain
+ ':'.
type: string
mountPropagation:
- description: 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.
+ description: 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.
type: string
name:
description: This must match the Name of a Volume.
type: string
readOnly:
- description: Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
+ description: Mounted read-only if true, read-write
+ otherwise (false or unspecified). Defaults to
+ false.
type: boolean
subPath:
- description: Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
+ description: Path within the volume from which the
+ container's volume should be mounted. Defaults
+ to "" (volume's root).
type: string
subPathExpr:
- description: 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.
+ description: 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.
type: string
required:
- mountPath
@@ -9082,60 +14606,100 @@
description: Name of the volume
type: string
source:
- description: Source is the source of the Volume to be loaded into the solrCloud Pod
+ description: Source is the source of the Volume to be
+ loaded into the solrCloud Pod
properties:
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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 TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume
+ that you want to mount. Tip: Ensure that the
+ filesystem 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
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: '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).'
+ description: '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).'
format: int32
type: integer
readOnly:
- description: 'Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'Specify "true" to force and set
+ the ReadOnly property in VolumeMounts to "true".
+ If omitted, the default is "false". More info:
+ https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: boolean
volumeID:
- description: 'Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
+ description: 'Unique ID of the persistent disk
+ resource in AWS (Amazon EBS volume). More
+ info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore'
type: string
required:
- volumeID
type: object
azureDisk:
- description: AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+ description: AzureDisk represents an Azure Data
+ Disk mount on the host and bind mount to the pod.
properties:
cachingMode:
- description: 'Host Caching mode: None, Read Only, Read Write.'
+ description: 'Host Caching mode: None, Read
+ Only, Read Write.'
type: string
diskName:
- description: The Name of the data disk in the blob storage
+ description: The Name of the data disk in the
+ blob storage
type: string
diskURI:
- description: The URI the data disk in the blob storage
+ description: The URI the data disk in the blob
+ storage
type: string
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
kind:
- description: 'Expected values 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'
+ description: 'Expected values 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'
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
required:
- diskName
- diskURI
type: object
azureFile:
- description: AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
+ description: AzureFile represents an Azure File
+ Service mount on the host and bind mount to the
+ pod.
properties:
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretName:
- description: the name of secret that contains Azure Storage Account Name and Key
+ description: the name of secret that contains
+ Azure Storage Account Name and Key
type: string
shareName:
description: Share Name
@@ -9145,78 +14709,142 @@
- shareName
type: object
cephfs:
- description: CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
+ description: CephFS represents a Ceph FS mount on
+ the host that shares a pod's lifetime
properties:
monitors:
- description: 'Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'Required: Monitors is a collection
+ of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
items:
type: string
type: array
path:
- description: 'Optional: Used as the mounted root, rather than the full Ceph tree, default is /'
+ description: 'Optional: Used as the mounted
+ root, rather than the full Ceph tree, default
+ is /'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
secretFile:
- description: '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'
+ description: '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'
type: string
secretRef:
- description: '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'
+ description: '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'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
user:
- description: 'Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
+ description: 'Optional: User is the rados user
+ name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it'
type: string
required:
- monitors
type: object
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'
+ description: 'Cinder represents a cinder volume
+ attached and mounted on kubelets host machine.
+ More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
properties:
fsType:
- description: 'Filesystem type to mount. Must be a filesystem 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'
+ description: 'Filesystem type to mount. Must
+ be a filesystem 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'
type: string
readOnly:
- description: 'Optional: 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'
+ description: 'Optional: 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'
type: boolean
secretRef:
- description: 'Optional: points to a secret object containing parameters used to connect to OpenStack.'
+ description: 'Optional: points to a secret object
+ containing parameters used to connect to OpenStack.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
volumeID:
- description: 'volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
+ description: 'volume id used to identify the
+ volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md'
type: string
required:
- volumeID
type: object
configMap:
- description: ConfigMap represents a configMap that should populate this volume
+ description: ConfigMap represents a configMap that
+ should populate this volume
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: 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 '..'.
+ description: 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 '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to a path within
+ a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -9224,85 +14852,156 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its keys must be defined
+ description: Specify whether the ConfigMap or
+ its keys must be defined
type: boolean
type: object
csi:
- description: CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
+ description: CSI (Container Storage Interface) represents
+ ephemeral storage that is handled by certain external
+ CSI drivers (Beta feature).
properties:
driver:
- description: Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
+ description: Driver is the name of the CSI driver
+ that handles this volume. Consult with your
+ admin for the correct name as registered in
+ the cluster.
type: string
fsType:
- description: Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.
+ description: Filesystem type to mount. Ex. "ext4",
+ "xfs", "ntfs". If not provided, the empty
+ value is passed to the associated CSI driver
+ which will determine the default filesystem
+ to apply.
type: string
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.
+ 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.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
readOnly:
- description: Specifies a read-only configuration for the volume. Defaults to false (read/write).
+ description: Specifies a read-only configuration
+ for the volume. Defaults to false (read/write).
type: boolean
volumeAttributes:
additionalProperties:
type: string
- description: VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
+ description: VolumeAttributes stores driver-specific
+ properties that are passed to the CSI driver.
+ Consult your driver's documentation for supported
+ values.
type: object
required:
- driver
type: object
downwardAPI:
- description: DownwardAPI represents downward API about the pod that should populate this volume
+ description: DownwardAPI represents downward API
+ about the pod that should populate this volume
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: Items is a list of downward API volume file
+ description: Items is a list of downward API
+ volume file
items:
- description: DownwardAPIVolumeFile represents information to create the file containing the pod field
+ description: DownwardAPIVolumeFile represents
+ information to create the file containing
+ the pod field
properties:
fieldRef:
- description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
+ description: 'Required: Selects a field
+ of the pod: only annotations, labels,
+ name and namespace are supported.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of the schema
+ the FieldPath is written in terms
+ of, defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the field to
+ select in the specified API version.
type: string
required:
- fieldPath
type: object
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative path name 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 ''..'''
+ description: 'Required: Path is the relative
+ path name 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 ''..'''
type: string
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.'
+ description: 'Selects a resource of the
+ container: only resources limits and
+ requests (limits.cpu, limits.memory,
+ requests.cpu and requests.memory) are
+ currently supported.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container name: required
+ for volumes, optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the output
+ format of the exposed resources,
+ defaults to "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
- description: 'Required: resource to select'
+ description: 'Required: resource to
+ select'
type: string
required:
- resource
@@ -9313,57 +15012,147 @@
type: array
type: object
emptyDir:
- description: 'EmptyDir represents a temporary directory that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
+ description: 'EmptyDir represents a temporary directory
+ that shares a pod''s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir'
properties:
medium:
- description: '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'
+ description: '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'
type: string
sizeLimit:
anyOf:
- type: integer
- type: string
- description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
+ description: '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: http://kubernetes.io/docs/user-guide/volumes#emptydir'
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
ephemeral:
- description: "Ephemeral represents a volume that is handled by a cluster storage driver (Alpha feature). 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."
+ description: "Ephemeral represents a volume that
+ is handled by a cluster storage driver (Alpha
+ feature). 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."
properties:
readOnly:
- description: Specifies a read-only configuration for the volume. Defaults to false (read/write).
+ description: Specifies a read-only configuration
+ for the volume. Defaults to false (read/write).
type: boolean
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). \n 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. \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."
+ 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).
+ \n 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. \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."
properties:
metadata:
- description: 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.
+ description: 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.
type: object
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.
+ 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.
properties:
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'
+ description: 'AccessModes contains the
+ desired access modes the volume should
+ have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1'
items:
type: string
type: array
dataSource:
- description: 'This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. 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.'
+ description: 'This field can be used
+ to specify either: * An existing VolumeSnapshot
+ object (snapshot.storage.k8s.io/VolumeSnapshot)
+ * An existing PVC (PersistentVolumeClaim)
+ * An existing custom resource that
+ implements data population (Alpha)
+ In order to use custom resource types
+ that implement data population, the
+ AnyVolumeDataSource feature gate must
+ be enabled. 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.'
properties:
apiGroup:
- description: 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.
+ description: 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.
type: string
kind:
- description: Kind is the type of resource being referenced
+ description: Kind is the type of
+ resource being referenced
type: string
name:
- description: Name is the name of resource being referenced
+ description: Name is the name of
+ resource being referenced
type: string
required:
- kind
- name
type: object
resources:
- description: 'Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
+ description: 'Resources represents the
+ minimum resources the volume should
+ have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources'
properties:
limits:
additionalProperties:
@@ -9372,7 +15161,9 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- description: 'Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ description: 'Limits describes the
+ maximum amount of compute resources
+ allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
requests:
additionalProperties:
@@ -9381,25 +15172,54 @@
- type: string
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
- 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. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
+ 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.
+ More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/'
type: object
type: object
selector:
- description: A label query over volumes to consider for binding.
+ description: A label query over volumes
+ to consider for binding.
properties:
matchExpressions:
- description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ description: matchExpressions is
+ a list of label selector requirements.
+ The requirements are ANDed.
items:
- description: A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+ description: A label selector
+ requirement is a selector that
+ contains values, a key, and
+ an operator that relates the
+ key and values.
properties:
key:
- description: key is the label key that the selector applies to.
+ description: key is the label
+ key that the selector applies
+ to.
type: string
operator:
- description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ description: operator represents
+ a key's relationship to
+ a set of values. Valid operators
+ are In, NotIn, Exists and
+ DoesNotExist.
type: string
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.
+ 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.
items:
type: string
type: array
@@ -9411,17 +15231,32 @@
matchLabels:
additionalProperties:
type: string
- 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.
+ 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
type: object
storageClassName:
- description: 'Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
+ description: 'Name of the StorageClass
+ required by the claim. More info:
+ https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1'
type: string
volumeMode:
- description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
+ description: volumeMode defines what
+ type of volume is required by the
+ claim. Value of Filesystem is implied
+ when not included in claim spec.
type: string
volumeName:
- description: VolumeName is the binding reference to the PersistentVolume backing this claim.
+ description: VolumeName is the binding
+ reference to the PersistentVolume
+ backing this claim.
type: string
type: object
required:
@@ -9429,90 +15264,157 @@
type: object
type: object
fc:
- description: FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
+ description: FC represents a Fibre Channel resource
+ that is attached to a kubelet's host machine and
+ then exposed to the pod.
properties:
fsType:
- description: 'Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
lun:
description: 'Optional: FC target lun number'
format: int32
type: integer
readOnly:
- description: 'Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'Optional: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.'
type: boolean
targetWWNs:
- description: 'Optional: FC target worldwide names (WWNs)'
+ description: 'Optional: FC target worldwide
+ names (WWNs)'
items:
type: string
type: array
wwids:
- description: 'Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.'
+ description: 'Optional: FC volume world wide
+ identifiers (wwids) Either wwids or combination
+ of targetWWNs and lun must be set, but not
+ both simultaneously.'
items:
type: string
type: array
type: object
flexVolume:
- description: FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
+ description: FlexVolume represents a generic volume
+ resource that is provisioned/attached using an
+ exec based plugin.
properties:
driver:
- description: Driver is the name of the driver to use for this volume.
+ description: Driver is the name of the driver
+ to use for this volume.
type: string
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ The default filesystem depends on FlexVolume
+ script.
type: string
options:
additionalProperties:
type: string
- description: 'Optional: Extra command options if any.'
+ description: 'Optional: Extra command options
+ if any.'
type: object
readOnly:
- description: 'Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.'
+ description: 'Optional: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.'
type: boolean
secretRef:
- description: '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.'
+ description: '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.'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
required:
- driver
type: object
flocker:
- description: Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
+ description: Flocker represents a Flocker volume
+ attached to a kubelet's host machine. This depends
+ on the Flocker control service being running
properties:
datasetName:
- description: Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
+ description: Name of the dataset stored as metadata
+ -> name on the dataset for Flocker should
+ be considered as deprecated
type: string
datasetUUID:
- description: UUID of the dataset. This is unique identifier of a Flocker dataset
+ description: UUID of the dataset. This is unique
+ identifier of a Flocker dataset
type: string
type: object
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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 TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume
+ that you want to mount. Tip: Ensure that the
+ filesystem 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
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
partition:
- description: '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). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: '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). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
format: int32
type: integer
pdName:
- description: 'Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'Unique name of the PD resource
+ in GCE. Used to identify the disk in GCE.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: string
readOnly:
- description: 'ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
+ description: 'ReadOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
+ More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk'
type: boolean
required:
- pdName
type: object
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.'
+ 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.'
properties:
directory:
- description: 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.
+ description: 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.
type: string
repository:
description: Repository URL
@@ -9524,75 +15426,121 @@
- repository
type: object
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'
+ 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'
properties:
endpoints:
- description: 'EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'EndpointsName is the endpoint
+ name that details Glusterfs topology. More
+ info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
path:
- description: 'Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
+ description: 'Path is the Glusterfs volume path.
+ More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
required:
- endpoints
- path
type: object
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.'
+ 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.'
properties:
path:
- description: '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'
+ description: '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'
type: string
type:
- description: 'Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
+ description: 'Type for HostPath Volume Defaults
+ to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
type: string
required:
- path
type: object
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'
+ 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'
properties:
chapAuthDiscovery:
- description: whether support iSCSI Discovery CHAP authentication
+ description: whether support iSCSI Discovery
+ CHAP authentication
type: boolean
chapAuthSession:
- description: whether support iSCSI Session CHAP authentication
+ description: whether support iSCSI Session CHAP
+ authentication
type: boolean
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume
+ that you want to mount. Tip: Ensure that the
+ filesystem 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#iscsi
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
initiatorName:
- description: Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
+ description: Custom iSCSI Initiator Name. If
+ initiatorName is specified with iscsiInterface
+ simultaneously, new iSCSI interface <target
+ portal>:<volume name> will be created for
+ the connection.
type: string
iqn:
description: Target iSCSI Qualified Name.
type: string
iscsiInterface:
- description: iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
+ description: iSCSI Interface Name that uses
+ an iSCSI transport. Defaults to 'default'
+ (tcp).
type: string
lun:
description: iSCSI Target Lun number.
format: int32
type: integer
portals:
- description: 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).
+ description: 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).
items:
type: string
type: array
readOnly:
- description: ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
+ description: ReadOnly here will force the ReadOnly
+ setting in VolumeMounts. Defaults to false.
type: boolean
secretRef:
- description: CHAP Secret for iSCSI target and initiator authentication
+ description: CHAP Secret for iSCSI target and
+ initiator authentication
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
targetPortal:
- description: 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).
+ description: 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).
type: string
required:
- iqn
@@ -9600,89 +15548,160 @@
- targetPortal
type: object
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'
+ 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'
properties:
path:
- description: 'Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'Path that is exported by the NFS
+ server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
server:
- description: 'Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
+ description: 'Server is the hostname or IP address
+ of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs'
type: string
required:
- path
- server
type: object
persistentVolumeClaim:
- description: 'PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
+ description: 'PersistentVolumeClaimVolumeSource
+ represents a reference to a PersistentVolumeClaim
+ in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims'
properties:
claimName:
- description: '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'
+ description: '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'
type: string
readOnly:
- description: Will force the ReadOnly setting in VolumeMounts. Default false.
+ description: Will force the ReadOnly setting
+ in VolumeMounts. Default false.
type: boolean
required:
- claimName
type: object
photonPersistentDisk:
- description: PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
+ description: PhotonPersistentDisk represents a PhotonController
+ persistent disk attached and mounted on kubelets
+ host machine
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
pdID:
- description: ID that identifies Photon Controller persistent disk
+ description: ID that identifies Photon Controller
+ persistent disk
type: string
required:
- pdID
type: object
portworxVolume:
- description: PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
+ description: PortworxVolume represents a portworx
+ volume attached and mounted on kubelets host machine
properties:
fsType:
- description: FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
+ description: FSType represents the filesystem
+ type to mount Must be a filesystem type supported
+ by the host operating system. Ex. "ext4",
+ "xfs". Implicitly inferred to be "ext4" if
+ unspecified.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
volumeID:
- description: VolumeID uniquely identifies a Portworx volume
+ description: VolumeID uniquely identifies a
+ Portworx volume
type: string
required:
- volumeID
type: object
projected:
- description: Items for all in one resources secrets, configmaps, and downward API
+ description: Items for all in one resources secrets,
+ configmaps, and downward API
properties:
defaultMode:
- description: 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.
+ description: 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.
format: int32
type: integer
sources:
description: list of volume projections
items:
- description: Projection that may be projected along with other supported volume types
+ description: Projection that may be projected
+ along with other supported volume types
properties:
configMap:
- description: information about the configMap data to project
+ description: information about the configMap
+ data to project
properties:
items:
- description: 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 '..'.
+ description: 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
+ '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to
+ a path within a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -9690,54 +15709,102 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent.
+ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the ConfigMap or its keys must be defined
+ description: Specify whether the ConfigMap
+ or its keys must be defined
type: boolean
type: object
downwardAPI:
- description: information about the downwardAPI data to project
+ description: information about the downwardAPI
+ data to project
properties:
items:
- description: Items is a list of DownwardAPIVolume file
+ description: Items is a list of DownwardAPIVolume
+ file
items:
- description: DownwardAPIVolumeFile represents information to create the file containing the pod field
+ description: DownwardAPIVolumeFile
+ represents information to create
+ the file containing the pod field
properties:
fieldRef:
- description: 'Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.'
+ description: 'Required: Selects
+ a field of the pod: only annotations,
+ labels, name and namespace
+ are supported.'
properties:
apiVersion:
- description: Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ description: Version of
+ the schema the FieldPath
+ is written in terms of,
+ defaults to "v1".
type: string
fieldPath:
- description: Path of the field to select in the specified API version.
+ description: Path of the
+ field to select in the
+ specified API version.
type: string
required:
- fieldPath
type: object
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 'Required: Path is the relative path name 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 ''..'''
+ description: 'Required: Path
+ is the relative path name
+ 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 ''..'''
type: string
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.'
+ description: 'Selects a resource
+ of the container: only resources
+ limits and requests (limits.cpu,
+ limits.memory, requests.cpu
+ and requests.memory) are currently
+ supported.'
properties:
containerName:
- description: 'Container name: required for volumes, optional for env vars'
+ description: 'Container
+ name: required for volumes,
+ optional for env vars'
type: string
divisor:
anyOf:
- type: integer
- type: string
- description: Specifies the output format of the exposed resources, defaults to "1"
+ description: Specifies the
+ output format of the exposed
+ resources, defaults to
+ "1"
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
resource:
- description: 'Required: resource to select'
+ description: 'Required:
+ resource to select'
type: string
required:
- resource
@@ -9748,22 +15815,57 @@
type: array
type: object
secret:
- description: information about the secret data to project
+ description: information about the secret
+ data to project
properties:
items:
- description: 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 '..'.
+ description: 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
+ '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to
+ a path within a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -9771,24 +15873,49 @@
type: object
type: array
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent.
+ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret
+ or its key must be defined
type: boolean
type: object
serviceAccountToken:
- description: information about the serviceAccountToken data to project
+ description: information about the serviceAccountToken
+ data to project
properties:
audience:
- description: 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.
+ description: 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.
type: string
expirationSeconds:
- description: 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.
+ description: 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.
format: int64
type: integer
path:
- description: Path is the path relative to the mount point of the file to project the token into.
+ description: Path is the path relative
+ to the mount point of the file to
+ project the token into.
type: string
required:
- path
@@ -9797,103 +15924,159 @@
type: array
type: object
quobyte:
- description: Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
+ description: Quobyte represents a Quobyte mount
+ on the host that shares a pod's lifetime
properties:
group:
- description: Group to map volume access to Default is no group
+ description: Group to map volume access to Default
+ is no group
type: string
readOnly:
- description: ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
+ description: ReadOnly here will force the Quobyte
+ volume to be mounted with read-only permissions.
+ Defaults to false.
type: boolean
registry:
- description: 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
+ description: 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
type: string
tenant:
- description: Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ description: Tenant owning the given Quobyte
+ volume in the Backend Used with dynamically
+ provisioned Quobyte volumes, value is set
+ by the plugin
type: string
user:
- description: User to map volume access to Defaults to serivceaccount user
+ description: User to map volume access to Defaults
+ to serivceaccount user
type: string
volume:
- description: Volume is a string that references an already created Quobyte volume by name.
+ description: Volume is a string that references
+ an already created Quobyte volume by name.
type: string
required:
- registry
- volume
type: object
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'
+ 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'
properties:
fsType:
- description: 'Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem 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#rbd TODO: how do we prevent errors in the filesystem from compromising the machine'
+ description: 'Filesystem type of the volume
+ that you want to mount. Tip: Ensure that the
+ filesystem 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#rbd
+ TODO: how do we prevent errors in the filesystem
+ from compromising the machine'
type: string
image:
- description: 'The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'The rados image name. More info:
+ https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
keyring:
- description: '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'
+ description: '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'
type: string
monitors:
- description: 'A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'A collection of Ceph monitors.
+ More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
items:
type: string
type: array
pool:
- description: 'The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'The rados pool name. Default is
+ rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
readOnly:
- description: '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'
+ description: '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'
type: boolean
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'
+ 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'
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
user:
- description: 'The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
+ description: 'The rados user name. Default is
+ admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it'
type: string
required:
- image
- monitors
type: object
scaleIO:
- description: ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
+ description: ScaleIO represents a ScaleIO persistent
+ volume attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Default is "xfs".
type: string
gateway:
- description: The host address of the ScaleIO API Gateway.
+ description: The host address of the ScaleIO
+ API Gateway.
type: string
protectionDomain:
- description: The name of the ScaleIO Protection Domain for the configured storage.
+ description: The name of the ScaleIO Protection
+ Domain for the configured storage.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
+ description: SecretRef references to the secret
+ for ScaleIO user and other sensitive information.
+ If this is not provided, Login operation will
+ fail.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
sslEnabled:
- description: Flag to enable/disable SSL communication with Gateway, default false
+ description: Flag to enable/disable SSL communication
+ with Gateway, default false
type: boolean
storageMode:
- description: Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
+ description: Indicates whether the storage for
+ a volume should be ThickProvisioned or ThinProvisioned.
+ Default is ThinProvisioned.
type: string
storagePool:
- description: The ScaleIO Storage Pool associated with the protection domain.
+ description: The ScaleIO Storage Pool associated
+ with the protection domain.
type: string
system:
- description: The name of the storage system as configured in ScaleIO.
+ description: The name of the storage system
+ as configured in ScaleIO.
type: string
volumeName:
- description: The name of a volume already created in the ScaleIO system that is associated with this volume source.
+ description: The name of a volume already created
+ in the ScaleIO system that is associated with
+ this volume source.
type: string
required:
- gateway
@@ -9901,26 +16084,63 @@
- system
type: object
secret:
- description: 'Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'Secret represents a secret that should
+ populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
properties:
defaultMode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
items:
- description: 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 '..'.
+ description: 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 '..'.
items:
- description: Maps a string key to a path within a volume.
+ description: Maps a string key to a path within
+ a volume.
properties:
key:
description: The key to project.
type: string
mode:
- description: '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.'
+ description: '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.'
format: int32
type: integer
path:
- description: 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 '..'.
+ description: 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 '..'.
type: string
required:
- key
@@ -9928,49 +16148,80 @@
type: object
type: array
optional:
- description: Specify whether the Secret or its keys must be defined
+ description: Specify whether the Secret or its
+ keys must be defined
type: boolean
secretName:
- description: 'Name of the secret in the pod''s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
+ description: 'Name of the secret in the pod''s
+ namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret'
type: string
type: object
storageos:
- description: StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
+ description: StorageOS represents a StorageOS volume
+ attached and mounted on Kubernetes nodes.
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
readOnly:
- description: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ description: Defaults to false (read/write).
+ ReadOnly here will force the ReadOnly setting
+ in VolumeMounts.
type: boolean
secretRef:
- description: SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
+ description: SecretRef specifies the secret
+ to use for obtaining the StorageOS API credentials. If
+ not specified, default values will be attempted.
properties:
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More
+ info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion,
+ kind, uid?'
type: string
type: object
volumeName:
- description: VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
+ description: VolumeName is the human-readable
+ name of the StorageOS volume. Volume names
+ are only unique within a namespace.
type: string
volumeNamespace:
- description: 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 do not pre-exist within StorageOS will be created.
+ description: 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 do not pre-exist
+ within StorageOS will be created.
type: string
type: object
vsphereVolume:
- description: VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
+ description: VsphereVolume represents a vSphere
+ volume attached and mounted on kubelets host machine
properties:
fsType:
- description: Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ description: Filesystem type to mount. Must
+ be a filesystem type supported by the host
+ operating system. Ex. "ext4", "xfs", "ntfs".
+ Implicitly inferred to be "ext4" if unspecified.
type: string
storagePolicyID:
- description: Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
+ description: Storage Policy Based Management
+ (SPBM) profile ID associated with the StoragePolicyName.
type: string
storagePolicyName:
- description: Storage Policy Based Management (SPBM) profile name.
+ description: Storage Policy Based Management
+ (SPBM) profile name.
type: string
volumePath:
- description: Path that identifies vSphere volume vmdk
+ description: Path that identifies vSphere volume
+ vmdk
type: string
required:
- volumePath
@@ -9983,7 +16234,8 @@
type: array
type: object
serviceOptions:
- description: ServiceOptions defines the custom options for the solrPrometheusExporter Service.
+ description: ServiceOptions defines the custom options for the
+ solrPrometheusExporter Service.
properties:
annotations:
additionalProperties:
@@ -9998,7 +16250,8 @@
type: object
type: object
exporterEntrypoint:
- description: The entrypoint into the exporter. Defaults to the official docker-solr location.
+ description: The entrypoint into the exporter. Defaults to the official
+ docker-solr location.
type: string
image:
description: Image of Solr Prometheus Exporter to run.
@@ -10006,7 +16259,8 @@
imagePullSecret:
type: string
pullPolicy:
- description: PullPolicy describes a policy for if/when to pull a container image
+ description: PullPolicy describes a policy for if/when to pull
+ a container image
type: string
repository:
type: string
@@ -10017,45 +16271,67 @@
description: The xml config for the metrics
type: string
numThreads:
- description: Number of threads to use for the prometheus exporter Defaults to 1
+ description: Number of threads to use for the prometheus exporter
+ Defaults to 1
format: int32
type: integer
restartSchedule:
- description: "Perform a scheduled restart on the given schedule, in CRON format. \n Multiple CRON syntaxes are supported - Standard CRON (e.g. \"CRON_TZ=Asia/Seoul 0 6 * * ?\") - Predefined Schedules (e.g. \"@yearly\", \"@weekly\", etc.) - Intervals (e.g. \"@every 10h30m\") \n For more information please check this reference: https://pkg.go.dev/github.com/robfig/cron/v3?utm_source=godoc#hdr-CRON_Expression_Format"
+ description: "Perform a scheduled restart on the given schedule, in
+ CRON format. \n Multiple CRON syntaxes are supported - Standard
+ CRON (e.g. \"CRON_TZ=Asia/Seoul 0 6 * * ?\") - Predefined Schedules
+ (e.g. \"@yearly\", \"@weekly\", etc.) - Intervals (e.g. \"@every
+ 10h30m\") \n For more information please check this reference: https://pkg.go.dev/github.com/robfig/cron/v3?utm_source=godoc#hdr-CRON_Expression_Format"
type: string
scrapeInterval:
- description: The interval to scrape Solr at (in seconds) Defaults to 60 seconds
+ description: The interval to scrape Solr at (in seconds) Defaults
+ to 60 seconds
format: int32
type: integer
solrReference:
description: Reference of the Solr instance to collect metrics for
properties:
basicAuthSecret:
- description: 'If Solr is secured, you''ll need to provide credentials for the Prometheus exporter to authenticate via a kubernetes.io/basic-auth secret which must contain a username and password. If basic auth is enabled on the SolrCloud instance, the default secret (unless you are supplying your own) is named using the pattern: <SOLR_CLOUD_NAME>-solrcloud-basic-auth. If using the security.json bootstrapped by the Solr operator, then the username is "k8s-oper".'
+ description: 'If Solr is secured, you''ll need to provide credentials
+ for the Prometheus exporter to authenticate via a kubernetes.io/basic-auth
+ secret which must contain a username and password. If basic
+ auth is enabled on the SolrCloud instance, the default secret
+ (unless you are supplying your own) is named using the pattern:
+ <SOLR_CLOUD_NAME>-solrcloud-basic-auth. If using the security.json
+ bootstrapped by the Solr operator, then the username is "k8s-oper".'
type: string
cloud:
description: Reference of a solrCloud instance
properties:
name:
- description: The name of a solr cloud running within the kubernetes cluster
+ description: The name of a solr cloud running within the kubernetes
+ cluster
type: string
namespace:
- description: The namespace of a solr cloud running within the kubernetes cluster
+ description: The namespace of a solr cloud running within
+ the kubernetes cluster
type: string
zkConnectionInfo:
- description: The ZK Connection information for a cloud, could be used for solr's running outside of the kube cluster
+ description: The ZK Connection information for a cloud, could
+ be used for solr's running outside of the kube cluster
properties:
acl:
- description: ZooKeeper ACL to use when connecting with ZK. This ACL should have ALL permission in the given chRoot.
+ description: ZooKeeper ACL to use when connecting with
+ ZK. This ACL should have ALL permission in the given
+ chRoot.
properties:
passwordKey:
- description: The name of the key in the given secret that contains the ACL password
+ description: The name of the key in the given secret
+ that contains the ACL password
type: string
secret:
- description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
+ description: The name of the Kubernetes Secret that
+ stores the username and password for the ACL. This
+ secret must be in the same namespace as the solrCloud
+ or prometheusExporter is running in.
type: string
usernameKey:
- description: The name of the key in the given secret that contains the ACL username
+ description: The name of the key in the given secret
+ that contains the ACL username
type: string
required:
- passwordKey
@@ -10066,22 +16342,33 @@
description: The ChRoot to connect solr at
type: string
externalConnectionString:
- description: The connection string to connect to the ensemble from outside of the Kubernetes cluster If external and no internal connection string is provided, the external cnx string will be used as the internal cnx string
+ description: The connection string to connect to the ensemble
+ from outside of the Kubernetes cluster If external and
+ no internal connection string is provided, the external
+ cnx string will be used as the internal cnx string
type: string
internalConnectionString:
- description: The connection string to connect to the ensemble from within the Kubernetes cluster
+ description: The connection string to connect to the ensemble
+ from within the Kubernetes cluster
type: string
readOnlyAcl:
- description: ZooKeeper ACL to use when connecting with ZK for reading operations. This ACL should have READ permission in the given chRoot.
+ description: ZooKeeper ACL to use when connecting with
+ ZK for reading operations. This ACL should have READ
+ permission in the given chRoot.
properties:
passwordKey:
- description: The name of the key in the given secret that contains the ACL password
+ description: The name of the key in the given secret
+ that contains the ACL password
type: string
secret:
- description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
+ description: The name of the Kubernetes Secret that
+ stores the username and password for the ACL. This
+ secret must be in the same namespace as the solrCloud
+ or prometheusExporter is running in.
type: string
usernameKey:
- description: The name of the key in the given secret that contains the ACL username
+ description: The name of the key in the given secret
+ that contains the ACL username
type: string
required:
- passwordKey
@@ -10091,105 +16378,151 @@
type: object
type: object
solrTLS:
- description: Settings to configure the SolrJ client used to request metrics from TLS enabled Solr pods
+ description: Settings to configure the SolrJ client used to request
+ metrics from TLS enabled Solr pods
properties:
checkPeerName:
- description: TLS certificates contain host/ip "peer name" information that is validated by default.
+ description: TLS certificates contain host/ip "peer name"
+ information that is validated by default.
type: boolean
clientAuth:
default: None
- description: Determines the client authentication method, either None, Want, or Need; this affects K8s ability to call liveness / readiness probes so use cautiously. Only applies for server certificates, has no effect on client certificates
+ description: Determines the client authentication method,
+ either None, Want, or Need; this affects K8s ability to
+ call liveness / readiness probes so use cautiously. Only
+ applies for server certificates, has no effect on client
+ certificates
enum:
- None
- Want
- Need
type: string
keyStorePasswordSecret:
- description: Secret containing the key store password; this field is required unless mountedTLSDir is used, as most JVMs do not support pkcs12 keystores without a password
+ description: Secret containing the key store password; this
+ field is required unless mountedTLSDir is used, as most
+ JVMs do not support pkcs12 keystores without a password
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must
+ be defined
type: boolean
required:
- key
type: object
mountedTLSDir:
- description: Used to specify a path where the keystore, truststore, and password files for the TLS certificate are mounted by an external agent or CSI driver. This option is typically used with `spec.updateStrategy.restartSchedule` to restart Solr pods before the mounted TLS cert expires.
+ description: Used to specify a path where the keystore, truststore,
+ and password files for the TLS certificate are mounted by
+ an external agent or CSI driver. This option is typically
+ used with `spec.updateStrategy.restartSchedule` to restart
+ Solr pods before the mounted TLS cert expires.
properties:
keystoreFile:
- description: Override the name of the keystore file; no default, if you don't supply this setting, then the corresponding env vars and Java system properties will not be configured for the pod template
+ description: Override the name of the keystore file; no
+ default, if you don't supply this setting, then the
+ corresponding env vars and Java system properties will
+ not be configured for the pod template
type: string
keystorePasswordFile:
- description: Override the name of the keystore password file; defaults to keystore-password
+ description: Override the name of the keystore password
+ file; defaults to keystore-password
type: string
path:
- description: The path on the main Solr container where the TLS files are mounted by some external agent or CSI Driver
+ description: The path on the main Solr container where
+ the TLS files are mounted by some external agent or
+ CSI Driver
type: string
truststoreFile:
- description: Override the name of the truststore file; no default, if you don't supply this setting, then the corresponding env vars and Java system properties will not be configured for the pod template
+ description: Override the name of the truststore file;
+ no default, if you don't supply this setting, then the
+ corresponding env vars and Java system properties will
+ not be configured for the pod template
type: string
truststorePasswordFile:
- description: Override the name of the truststore password file; defaults to the same value as the KeystorePasswordFile
+ description: Override the name of the truststore password
+ file; defaults to the same value as the KeystorePasswordFile
type: string
required:
- path
type: object
pkcs12Secret:
- description: TLS Secret containing a pkcs12 keystore; required for Solr pods unless mountedTLSDir is used
+ description: TLS Secret containing a pkcs12 keystore; required
+ for Solr pods unless mountedTLSDir is used
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must
+ be defined
type: boolean
required:
- key
type: object
restartOnTLSSecretUpdate:
- description: Opt-in flag to restart Solr pods after TLS secret updates, such as if the cert is renewed; default is false. This option only applies when using the `spec.solrTLS.pkcs12Secret` option; when using the `spec.solrTLS.mountedTLSDir` option, you need to ensure pods get restarted before the certs expire, see `spec.updateStrategy.restartSchedule` for scheduling restarts.
+ description: Opt-in flag to restart Solr pods after TLS secret
+ updates, such as if the cert is renewed; default is false.
+ This option only applies when using the `spec.solrTLS.pkcs12Secret`
+ option; when using the `spec.solrTLS.mountedTLSDir` option,
+ you need to ensure pods get restarted before the certs expire,
+ see `spec.updateStrategy.restartSchedule` for scheduling
+ restarts.
type: boolean
trustStorePasswordSecret:
- description: Secret containing the trust store password; if not provided the keyStorePassword will be used
+ description: Secret containing the trust store password; if
+ not provided the keyStorePassword will be used
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must
+ be defined
type: boolean
required:
- key
type: object
trustStoreSecret:
- description: TLS Secret containing a pkcs12 truststore; if not provided, then the keystore and password are used for the truststore The specified key is used as the truststore file name when mounted into Solr pods
+ description: TLS Secret containing a pkcs12 truststore; if
+ not provided, then the keystore and password are used for
+ the truststore The specified key is used as the truststore
+ file name when mounted into Solr pods
properties:
key:
- description: The key of the secret to select from. Must be a valid secret key.
+ description: The key of the secret to select from. Must
+ be a valid secret key.
type: string
name:
- description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ TODO: Add other useful fields. apiVersion, kind, uid?'
type: string
optional:
- description: Specify whether the Secret or its key must be defined
+ description: Specify whether the Secret or its key must
+ be defined
type: boolean
required:
- key
type: object
verifyClientHostname:
- description: Verify client's hostname during SSL handshake Only applies for server configuration
+ description: Verify client's hostname during SSL handshake
+ Only applies for server configuration
type: boolean
type: object
standalone:
@@ -10206,7 +16539,8 @@
- solrReference
type: object
status:
- description: SolrPrometheusExporterStatus defines the observed state of SolrPrometheusExporter
+ description: SolrPrometheusExporterStatus defines the observed state of
+ SolrPrometheusExporter
properties:
ready:
description: Is the prometheus exporter up and running
