package k8s.io.api.core.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Represents a Persistent Disk resource in AWS. An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

Used in: PersistentVolumeSource, VolumeSource

• optional string volumeID = 1

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

• optional string fsType = 2

  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 +optional

• optional int32 partition = 3

  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). +optional

• optional bool readOnly = 4

  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 +optional

Affinity is a group of affinity scheduling rules.

Used in: PodSpec

• optional NodeAffinity nodeAffinity = 1

  Describes node affinity scheduling rules for the pod. +optional

• optional PodAffinity podAffinity = 2

  Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). +optional

• optional PodAntiAffinity podAntiAffinity = 3

  Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). +optional

AttachedVolume describes a volume attached to a node

Used in: NodeStatus

• optional string name = 1

  Name of the attached volume

• optional string devicePath = 2

  DevicePath represents the device path where the volume should be available

AvoidPods describes pods that should avoid this node. This is the value for a Node annotation with key scheduler.alpha.kubernetes.io/preferAvoidPods and will eventually become a field of NodeStatus.

• repeated PreferAvoidPodsEntry preferAvoidPods = 1

  Bounded-sized list of signatures of pods that should avoid this node, sorted in timestamp order from oldest to newest. Size of the slice is unspecified. +optional

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

Used in: PersistentVolumeSource, VolumeSource

• optional string diskName = 1

  The Name of the data disk in the blob storage

• optional string diskURI = 2

  The URI the data disk in the blob storage

• optional string cachingMode = 3

  Host Caching mode: None, Read Only, Read Write. +optional

• optional string fsType = 4

  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. +optional

• optional bool readOnly = 5

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

• optional string kind = 6

  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

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

Used in: PersistentVolumeSource

• optional string secretName = 1

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

• optional string shareName = 2

  Share Name

• optional bool readOnly = 3

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

• optional string secretNamespace = 4

  the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod +optional

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

Used in: VolumeSource

• optional string secretName = 1

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

• optional string shareName = 2

  Share Name

• optional bool readOnly = 3

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

Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead.

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional ObjectReference target = 2

  The target object that you want to bind to the standard object.

Represents storage that is managed by an external CSI volume driver (Beta feature)

Used in: PersistentVolumeSource

• optional string driver = 1

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

• optional string volumeHandle = 2

  VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.

• optional bool readOnly = 3

  Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write). +optional

• optional string fsType = 4

  Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". +optional

• map<string, string> volumeAttributes = 5

  Attributes of the volume to publish. +optional

• optional SecretReference controllerPublishSecretRef = 6

  ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. +optional

• optional SecretReference nodeStageSecretRef = 7

  NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. +optional

• optional SecretReference nodePublishSecretRef = 8

  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 secrets are passed. +optional

• optional SecretReference controllerExpandSecretRef = 9

  ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This is an alpha field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. +optional

Represents a source location of a volume to mount, managed by an external CSI driver

Used in: VolumeSource

• optional string driver = 1

  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.

• optional bool readOnly = 2

  Specifies a read-only configuration for the volume. Defaults to false (read/write). +optional

• optional string fsType = 3

  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. +optional

• map<string, string> volumeAttributes = 4

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

• optional LocalObjectReference nodePublishSecretRef = 5

  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. +optional

Adds and removes POSIX capabilities from running containers.

Used in: SecurityContext

• repeated string add = 1

  Added capabilities +optional

• repeated string drop = 2

  Removed capabilities +optional

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

Used in: PersistentVolumeSource

• repeated string monitors = 1

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

• optional string path = 2

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

• optional string user = 3

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

• optional string secretFile = 4

  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 +optional

• optional SecretReference secretRef = 5

  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 +optional

• optional bool readOnly = 6

  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 +optional

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

Used in: VolumeSource

• repeated string monitors = 1

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

• optional string path = 2

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

• optional string user = 3

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

• optional string secretFile = 4

  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 +optional

• optional LocalObjectReference secretRef = 5

  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 +optional

• optional bool readOnly = 6

  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 +optional

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

Used in: PersistentVolumeSource

• optional string volumeID = 1

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

• optional string fsType = 2

  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 +optional

• optional bool readOnly = 3

  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 +optional

• optional SecretReference secretRef = 4

  Optional: points to a secret object containing parameters used to connect to OpenStack. +optional

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

Used in: VolumeSource

• optional string volumeID = 1

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

• optional string fsType = 2

  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 +optional

• optional bool readOnly = 3

  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 +optional

• optional LocalObjectReference secretRef = 4

  Optional: points to a secret object containing parameters used to connect to OpenStack. +optional

ClientIPConfig represents the configurations of Client IP based session affinity.

Used in: SessionAffinityConfig

• optional int32 timeoutSeconds = 1

  timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). +optional

Information about the condition of a component.

Used in: ComponentStatus

• optional string type = 1

  Type of condition for a component. Valid value: "Healthy"

• optional string status = 2

  Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".

• optional string message = 3

  Message about the condition for a component. For example, information about a health check. +optional

• optional string error = 4

  Condition error code for a component. For example, a health check error code. +optional

ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+

Used in: ComponentStatusList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• repeated ComponentCondition conditions = 2

  List of component conditions observed +optional +patchMergeKey=type +patchStrategy=merge

Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• repeated ComponentStatus items = 2

  List of ComponentStatus objects.

ConfigMap holds configuration data for pods to consume.

Used in: ConfigMapList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional bool immutable = 4

  Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. +optional

• map<string, string> data = 2

  Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process. +optional

• map<string, bytes> binaryData = 3

  BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet. +optional

ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.

Used in: EnvFromSource

• optional LocalObjectReference localObjectReference = 1

  The ConfigMap to select from.

• optional bool optional = 2

  Specify whether the ConfigMap must be defined +optional

Selects a key from a ConfigMap.

Used in: EnvVarSource

• optional LocalObjectReference localObjectReference = 1

  The ConfigMap to select from.

• optional string key = 2

  The key to select.

• optional bool optional = 3

  Specify whether the ConfigMap or its key must be defined +optional

ConfigMapList is a resource containing a list of ConfigMap objects.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• repeated ConfigMap items = 2

  Items is the list of ConfigMaps.

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.

Used in: NodeConfigSource

• optional string namespace = 1

  Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.

• optional string name = 2

  Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.

• optional string uid = 3

  UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. +optional

• optional string resourceVersion = 4

  ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. +optional

• optional string kubeletConfigKey = 5

  KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.

Adapts a ConfigMap into a projected volume. The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.

Used in: VolumeProjection

• optional LocalObjectReference localObjectReference = 1

• repeated KeyToPath items = 2

  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 '..'. +optional

• optional bool optional = 4

  Specify whether the ConfigMap or its keys must be defined +optional

Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

Used in: VolumeSource

• optional LocalObjectReference localObjectReference = 1

• repeated KeyToPath items = 2

  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 '..'. +optional

• optional int32 defaultMode = 3

  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. +optional

• optional bool optional = 4

  Specify whether the ConfigMap or its keys must be defined +optional

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

Used in: PodSpec

• optional string name = 1

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

• optional string image = 2

  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. +optional

• repeated string command = 3

  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 +optional

• repeated string args = 4

  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 +optional

• optional string workingDir = 5

  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. +optional

• repeated ContainerPort ports = 6

  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. +optional +patchMergeKey=containerPort +patchStrategy=merge +listType=map +listMapKey=containerPort +listMapKey=protocol

• repeated EnvFromSource envFrom = 19

  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. +optional

• repeated EnvVar env = 7

  List of environment variables to set in the container. Cannot be updated. +optional +patchMergeKey=name +patchStrategy=merge

• optional ResourceRequirements resources = 8

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

• repeated VolumeMount volumeMounts = 9

  Pod volumes to mount into the container's filesystem. Cannot be updated. +optional +patchMergeKey=mountPath +patchStrategy=merge

• repeated VolumeDevice volumeDevices = 21

  volumeDevices is the list of block devices to be used by the container. +patchMergeKey=devicePath +patchStrategy=merge +optional

• optional Probe livenessProbe = 10

  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 +optional

• optional Probe readinessProbe = 11

  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 +optional

• optional Probe startupProbe = 22

  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 +optional

• optional Lifecycle lifecycle = 12

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

• optional string terminationMessagePath = 13

  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. +optional

• optional string terminationMessagePolicy = 20

  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. +optional

• optional string imagePullPolicy = 14

  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 +optional

• optional SecurityContext securityContext = 15

  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/ +optional

• optional bool stdin = 16

  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. +optional

• optional bool stdinOnce = 17

  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 +optional

• optional bool tty = 18

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

Describe a container image

Used in: NodeStatus

• repeated string names = 1

  Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]

• optional int64 sizeBytes = 2

  The size of the image in bytes. +optional

ContainerPort represents a network port in a single container.

Used in: Container, EphemeralContainerCommon

• optional string name = 1

  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. +optional

• optional int32 hostPort = 2

  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. +optional

• optional int32 containerPort = 3

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

• optional string protocol = 4

  Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". +optional +default="TCP"

• optional string hostIP = 5

  What host IP to bind the external port to. +optional

ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.

Used in: ContainerStatus

• optional ContainerStateWaiting waiting = 1

  Details about a waiting container +optional

• optional ContainerStateRunning running = 2

  Details about a running container +optional

• optional ContainerStateTerminated terminated = 3

  Details about a terminated container +optional

ContainerStateRunning is a running state of a container.

Used in: ContainerState

• optional apimachinery.pkg.apis.meta.v1.Time startedAt = 1

  Time at which the container was last (re-)started +optional

ContainerStateTerminated is a terminated state of a container.

Used in: ContainerState

• optional int32 exitCode = 1

  Exit status from the last termination of the container

• optional int32 signal = 2

  Signal from the last termination of the container +optional

• optional string reason = 3

  (brief) reason from the last termination of the container +optional

• optional string message = 4

  Message regarding the last termination of the container +optional

• optional apimachinery.pkg.apis.meta.v1.Time startedAt = 5

  Time at which previous execution of the container started +optional

• optional apimachinery.pkg.apis.meta.v1.Time finishedAt = 6

  Time at which the container last terminated +optional

• optional string containerID = 7

  Container's ID in the format 'docker://<container_id>' +optional

ContainerStateWaiting is a waiting state of a container.

Used in: ContainerState

• optional string reason = 1

  (brief) reason the container is not yet running. +optional

• optional string message = 2

  Message regarding why the container is not yet running. +optional

ContainerStatus contains details for the current status of this container.

Used in: PodStatus

• optional string name = 1

  This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.

• optional ContainerState state = 2

  Details about the container's current condition. +optional

• optional ContainerState lastState = 3

  Details about the container's last termination condition. +optional

• optional bool ready = 4

  Specifies whether the container has passed its readiness probe.

• optional int32 restartCount = 5

  The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.

• optional string image = 6

  The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images TODO(dchen1107): Which image the container is running with?

• optional string imageID = 7

  ImageID of the container's image.

• optional string containerID = 8

  Container's ID in the format 'docker://<container_id>'. +optional

• optional bool started = 9

  Specifies whether the container has passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. Is always true when no startupProbe is defined. +optional

DaemonEndpoint contains information about a single Daemon endpoint.

Used in: NodeDaemonEndpoints

• optional int32 Port = 1

  Port number of the given endpoint.

Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.

Used in: VolumeProjection

• repeated DownwardAPIVolumeFile items = 1

  Items is a list of DownwardAPIVolume file +optional

DownwardAPIVolumeFile represents information to create the file containing the pod field

Used in: DownwardAPIProjection, DownwardAPIVolumeSource

• optional string path = 1

  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 '..'

• optional ObjectFieldSelector fieldRef = 2

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

• optional ResourceFieldSelector resourceFieldRef = 3

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

• optional int32 mode = 4

  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. +optional

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

Used in: VolumeSource

• repeated DownwardAPIVolumeFile items = 1

  Items is a list of downward API volume file +optional

• optional int32 defaultMode = 2

  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. +optional

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

Used in: VolumeSource

• optional string medium = 1

  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 +optional

• optional apimachinery.pkg.api.resource.Quantity sizeLimit = 2

  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 +optional

EndpointAddress is a tuple that describes single IP address.

Used in: EndpointSubset

• optional string ip = 1

  The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready. TODO: This should allow hostname or IP, See #4447.

• optional string hostname = 3

  The Hostname of this endpoint +optional

• optional string nodeName = 4

  Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node. +optional

• optional ObjectReference targetRef = 2

  Reference to object providing the endpoint. +optional

EndpointPort is a tuple that describes a single port.

Used in: EndpointSubset

• optional string name = 1

  The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined. +optional

• optional int32 port = 2

  The port number of the endpoint.

• optional string protocol = 3

  The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. +optional

• optional string appProtocol = 4

  The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default. +optional

EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] } The resulting set of endpoints can be viewed as: a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], b: [ 10.10.1.1:309, 10.10.2.2:309 ]

Used in: Endpoints

• repeated EndpointAddress addresses = 1

  IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize. +optional

• repeated EndpointAddress notReadyAddresses = 2

  IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. +optional

• repeated EndpointPort ports = 3

  Port numbers available on the related IP addresses. +optional

Endpoints is a collection of endpoints that implement the actual service. Example: Name: "mysvc", Subsets: [ { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] }, { Addresses: [{"ip": "10.10.3.3"}], Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] }, ]

Used in: EndpointsList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• repeated EndpointSubset subsets = 2

  The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service. +optional

EndpointsList is a list of endpoints.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• repeated Endpoints items = 2

  List of endpoints.

EnvFromSource represents the source of a set of ConfigMaps

Used in: Container, EphemeralContainerCommon

• optional string prefix = 1

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

• optional ConfigMapEnvSource configMapRef = 2

  The ConfigMap to select from +optional

• optional SecretEnvSource secretRef = 3

  The Secret to select from +optional

EnvVar represents an environment variable present in a Container.

Used in: Container, EphemeralContainerCommon

• optional string name = 1

  Name of the environment variable. Must be a C_IDENTIFIER.

• optional string value = 2

  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 "". +optional

• optional EnvVarSource valueFrom = 3

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

EnvVarSource represents a source for the value of an EnvVar.

Used in: EnvVar

• optional ObjectFieldSelector fieldRef = 1

  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. +optional

• optional ResourceFieldSelector resourceFieldRef = 2

  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. +optional

• optional ConfigMapKeySelector configMapKeyRef = 3

  Selects a key of a ConfigMap. +optional

• optional SecretKeySelector secretKeyRef = 4

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

An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag.

Used in: EphemeralContainers, PodSpec

• optional EphemeralContainerCommon ephemeralContainerCommon = 1

  Ephemeral containers have all of the fields of Container, plus additional fields specific to ephemeral containers. Fields in common with Container are in the following inlined struct so than an EphemeralContainer may easily be converted to a Container.

• optional string targetContainerName = 2

  If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature. +optional

EphemeralContainerCommon is a copy of all fields in Container to be inlined in EphemeralContainer. This separate type allows easy conversion from EphemeralContainer to Container and allows separate documentation for the fields of EphemeralContainer. When a new field is added to Container it must be added here as well.

Used in: EphemeralContainer

• optional string name = 1

  Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.

• optional string image = 2

  Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images

• repeated string command = 3

  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 +optional

• repeated string args = 4

  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 +optional

• optional string workingDir = 5

  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. +optional

• repeated ContainerPort ports = 6

  Ports are not allowed for ephemeral containers.

• repeated EnvFromSource envFrom = 19

  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. +optional

• repeated EnvVar env = 7

  List of environment variables to set in the container. Cannot be updated. +optional +patchMergeKey=name +patchStrategy=merge

• optional ResourceRequirements resources = 8

  Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod. +optional

• repeated VolumeMount volumeMounts = 9

  Pod volumes to mount into the container's filesystem. Cannot be updated. +optional +patchMergeKey=mountPath +patchStrategy=merge

• repeated VolumeDevice volumeDevices = 21

  volumeDevices is the list of block devices to be used by the container. +patchMergeKey=devicePath +patchStrategy=merge +optional

• optional Probe livenessProbe = 10

  Probes are not allowed for ephemeral containers. +optional

• optional Probe readinessProbe = 11

  Probes are not allowed for ephemeral containers. +optional

• optional Probe startupProbe = 22

  Probes are not allowed for ephemeral containers. +optional

• optional Lifecycle lifecycle = 12

  Lifecycle is not allowed for ephemeral containers. +optional

• optional string terminationMessagePath = 13

  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. +optional

• optional string terminationMessagePolicy = 20

  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. +optional

• optional string imagePullPolicy = 14

  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 +optional

• optional SecurityContext securityContext = 15

  SecurityContext is not allowed for ephemeral containers. +optional

• optional bool stdin = 16

  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. +optional

• optional bool stdinOnce = 17

  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 +optional

• optional bool tty = 18

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

A list of ephemeral containers used with the Pod ephemeralcontainers subresource.

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  +optional

• repeated EphemeralContainer ephemeralContainers = 2

  A list of ephemeral containers associated with this pod. New ephemeral containers may be appended to this list, but existing ephemeral containers may not be removed or modified. +patchMergeKey=name +patchStrategy=merge

Represents an ephemeral volume that is handled by a normal storage driver.

Used in: VolumeSource

• optional PersistentVolumeClaimTemplate volumeClaimTemplate = 1

  Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.

• optional bool readOnly = 2

  Specifies a read-only configuration for the volume. Defaults to false (read/write). +optional

Event is a report of an event somewhere in the cluster. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.

Used in: EventList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

• optional ObjectReference involvedObject = 2

  The object that this event is about.

• optional string reason = 3

  This should be a short, machine understandable string that gives the reason for the transition into the object's current status. TODO: provide exact specification for format. +optional

• optional string message = 4

  A human-readable description of the status of this operation. TODO: decide on maximum length. +optional

• optional EventSource source = 5

  The component reporting this event. Should be a short machine understandable string. +optional

• optional apimachinery.pkg.apis.meta.v1.Time firstTimestamp = 6

  The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) +optional

• optional apimachinery.pkg.apis.meta.v1.Time lastTimestamp = 7

  The time at which the most recent occurrence of this event was recorded. +optional

• optional int32 count = 8

  The number of times this event has occurred. +optional

• optional string type = 9

  Type of this event (Normal, Warning), new types could be added in the future +optional

• optional apimachinery.pkg.apis.meta.v1.MicroTime eventTime = 10

  Time when this Event was first observed. +optional

• optional EventSeries series = 11

  Data about the Event series this event represents or nil if it's a singleton Event. +optional

• optional string action = 12

  What action was taken/failed regarding to the Regarding object. +optional

• optional ObjectReference related = 13

  Optional secondary object for more complex actions. +optional

• optional string reportingComponent = 14

  Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. +optional

• optional string reportingInstance = 15

  ID of the controller instance, e.g. `kubelet-xyzf`. +optional

EventList is a list of events.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• repeated Event items = 2

  List of events

EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.

Used in: Event

• optional int32 count = 1

  Number of occurrences in this series up to the last heartbeat time

• optional apimachinery.pkg.apis.meta.v1.MicroTime lastObservedTime = 2

  Time of the last occurrence observed

EventSource contains information for an event.

Used in: Event

• optional string component = 1

  Component from which the event is generated. +optional

• optional string host = 2

  Node name on which the event is generated. +optional

ExecAction describes a "run in container" action.

Used in: Handler

• repeated string command = 1

  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. +optional

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

Used in: PersistentVolumeSource, VolumeSource

• repeated string targetWWNs = 1

  Optional: FC target worldwide names (WWNs) +optional

• optional int32 lun = 2

  Optional: FC target lun number +optional

• optional string fsType = 3

  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 +optional

• optional bool readOnly = 4

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

• repeated string wwids = 5

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

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

Used in: PersistentVolumeSource

• optional string driver = 1

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

• optional string fsType = 2

  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. +optional

• optional SecretReference secretRef = 3

  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. +optional

• optional bool readOnly = 4

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

• map<string, string> options = 5

  Optional: Extra command options if any. +optional

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

Used in: VolumeSource

• optional string driver = 1

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

• optional string fsType = 2

  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. +optional

• optional LocalObjectReference secretRef = 3

  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. +optional

• optional bool readOnly = 4

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

• map<string, string> options = 5

  Optional: Extra command options if any. +optional

Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

Used in: PersistentVolumeSource, VolumeSource

• optional string datasetName = 1

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

• optional string datasetUUID = 2

  UUID of the dataset. This is unique identifier of a Flocker dataset +optional

Represents a Persistent Disk resource in Google Compute Engine. A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

Used in: PersistentVolumeSource, VolumeSource

• optional string pdName = 1

  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

• optional string fsType = 2

  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 +optional

• optional int32 partition = 3

  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 +optional

• optional bool readOnly = 4

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

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. 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.

Used in: VolumeSource

• optional string repository = 1

  Repository URL

• optional string revision = 2

  Commit hash for the specified revision. +optional

• optional string directory = 3

  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. +optional

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

Used in: PersistentVolumeSource

• optional string endpoints = 1

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

• optional string path = 2

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

• optional bool readOnly = 3

  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 +optional

• optional string endpointsNamespace = 4

  EndpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod +optional

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

Used in: VolumeSource

• optional string endpoints = 1

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

• optional string path = 2

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

• optional bool readOnly = 3

  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 +optional

HTTPGetAction describes an action based on HTTP Get requests.

Used in: Handler

• optional string path = 1

  Path to access on the HTTP server. +optional

• optional apimachinery.pkg.util.intstr.IntOrString port = 2

  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.

• optional string host = 3

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

• optional string scheme = 4

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

• repeated HTTPHeader httpHeaders = 5

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

HTTPHeader describes a custom header to be used in HTTP probes

Used in: HTTPGetAction

• optional string name = 1

  The header field name

• optional string value = 2

  The header field value

Handler defines a specific action that should be taken TODO: pass structured data to these actions, and document that data here.

Used in: Lifecycle, Probe

• optional ExecAction exec = 1

  One and only one of the following should be specified. Exec specifies the action to take. +optional

• optional HTTPGetAction httpGet = 2

  HTTPGet specifies the http request to perform. +optional

• optional TCPSocketAction tcpSocket = 3

  TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook +optional

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.

Used in: PodSpec

• optional string ip = 1

  IP address of the host file entry.

• repeated string hostnames = 2

  Hostnames for the above IP address.

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

Used in: PersistentVolumeSource, VolumeSource

• optional string path = 1

  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

• optional string type = 2

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

ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

Used in: PersistentVolumeSource

• optional string targetPortal = 1

  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).

• optional string iqn = 2

  Target iSCSI Qualified Name.

• optional int32 lun = 3

  iSCSI Target Lun number.

• optional string iscsiInterface = 4

  iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). +optional

• optional string fsType = 5

  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 +optional

• optional bool readOnly = 6

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

• repeated string portals = 7

  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). +optional

• optional bool chapAuthDiscovery = 8

  whether support iSCSI Discovery CHAP authentication +optional

• optional bool chapAuthSession = 11

  whether support iSCSI Session CHAP authentication +optional

• optional SecretReference secretRef = 10

  CHAP Secret for iSCSI target and initiator authentication +optional

• optional string initiatorName = 12

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

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

Used in: VolumeSource

• optional string targetPortal = 1

  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).

• optional string iqn = 2

  Target iSCSI Qualified Name.

• optional int32 lun = 3

  iSCSI Target Lun number.

• optional string iscsiInterface = 4

  iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). +optional

• optional string fsType = 5

  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 +optional

• optional bool readOnly = 6

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

• repeated string portals = 7

  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). +optional

• optional bool chapAuthDiscovery = 8

  whether support iSCSI Discovery CHAP authentication +optional

• optional bool chapAuthSession = 11

  whether support iSCSI Session CHAP authentication +optional

• optional LocalObjectReference secretRef = 10

  CHAP Secret for iSCSI target and initiator authentication +optional

• optional string initiatorName = 12

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

Maps a string key to a path within a volume.

Used in: ConfigMapProjection, ConfigMapVolumeSource, SecretProjection, SecretVolumeSource

• optional string key = 1

  The key to project.

• optional string path = 2

  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 '..'.

• optional int32 mode = 3

  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. +optional

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

Used in: Container, EphemeralContainerCommon

• optional Handler postStart = 1

  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 +optional

• optional Handler preStop = 2

  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 +optional

LimitRange sets resource usage limits for each kind of resource in a Namespace.

Used in: LimitRangeList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional LimitRangeSpec spec = 2

  Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

LimitRangeItem defines a min/max usage limit for any resource that matches on kind.

Used in: LimitRangeSpec

• optional string type = 1

  Type of resource that this limit applies to.

• map<string, apimachinery.pkg.api.resource.Quantity> max = 2

  Max usage constraints on this kind by resource name. +optional

• map<string, apimachinery.pkg.api.resource.Quantity> min = 3

  Min usage constraints on this kind by resource name. +optional

• map<string, apimachinery.pkg.api.resource.Quantity> default = 4

  Default resource requirement limit value by resource name if resource limit is omitted. +optional

• map<string, apimachinery.pkg.api.resource.Quantity> defaultRequest = 5

  DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. +optional

• map<string, apimachinery.pkg.api.resource.Quantity> maxLimitRequestRatio = 6

  MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource. +optional

LimitRangeList is a list of LimitRange items.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• repeated LimitRange items = 2

  Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

LimitRangeSpec defines a min/max usage limit for resources that match on kind.

Used in: LimitRange

• repeated LimitRangeItem limits = 1

  Limits is the list of LimitRangeItem objects that are enforced.

List holds a list of objects, which may not be known by the server.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• repeated apimachinery.pkg.runtime.RawExtension items = 2

  List of objects

LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.

Used in: LoadBalancerStatus

• optional string ip = 1

  IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers) +optional

• optional string hostname = 2

  Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers) +optional

• repeated PortStatus ports = 4

  Ports is a list of records of service ports If used, every port defined in the service should have an entry in it +listType=atomic +optional

LoadBalancerStatus represents the status of a load-balancer.

Used in: ServiceStatus

• repeated LoadBalancerIngress ingress = 1

  Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points. +optional

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Used in: CSIVolumeSource, CephFSVolumeSource, CinderVolumeSource, ConfigMapEnvSource, ConfigMapKeySelector, ConfigMapProjection, ConfigMapVolumeSource, FlexVolumeSource, ISCSIVolumeSource, PodSpec, RBDVolumeSource, ScaleIOVolumeSource, SecretEnvSource, SecretKeySelector, SecretProjection, ServiceAccount, StorageOSVolumeSource

• optional string name = 1

  Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? +optional

Local represents directly-attached storage with node affinity (Beta feature)

Used in: PersistentVolumeSource

• optional string path = 1

  The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).

• optional string fsType = 2

  Filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a fileystem if unspecified. +optional

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

Used in: PersistentVolumeSource, VolumeSource

• optional string server = 1

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

• optional string path = 2

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

• optional bool readOnly = 3

  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 +optional

Namespace provides a scope for Names. Use of multiple namespaces is optional.

Used in: NamespaceList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional NamespaceSpec spec = 2

  Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

• optional NamespaceStatus status = 3

  Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

NamespaceCondition contains details about state of namespace.

Used in: NamespaceStatus

• optional string type = 1

  Type of namespace controller condition.

• optional string status = 2

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

• optional apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 4

  +optional

• optional string reason = 5

  +optional

• optional string message = 6

  +optional

NamespaceList is a list of Namespaces.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• repeated Namespace items = 2

  Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

NamespaceSpec describes the attributes on a Namespace.

Used in: Namespace

• repeated string finalizers = 1

  Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ +optional

NamespaceStatus is information about the current status of a Namespace.

Used in: Namespace

• optional string phase = 1

  Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ +optional

• repeated NamespaceCondition conditions = 2

  Represents the latest available observations of a namespace's current state. +optional +patchMergeKey=type +patchStrategy=merge

Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).

Used in: NodeList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional NodeSpec spec = 2

  Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

• optional NodeStatus status = 3

  Most recently observed status of the node. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

NodeAddress contains information for the node's address.

Used in: NodeStatus

• optional string type = 1

  Node address type, one of Hostname, ExternalIP or InternalIP.

• optional string address = 2

  The node address.

Node affinity is a group of node affinity scheduling rules.

Used in: Affinity

• optional NodeSelector requiredDuringSchedulingIgnoredDuringExecution = 1

  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. +optional

• repeated PreferredSchedulingTerm preferredDuringSchedulingIgnoredDuringExecution = 2

  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. +optional

NodeCondition contains condition information for a node.

Used in: NodeStatus

• optional string type = 1

  Type of node condition.

• optional string status = 2

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

• optional apimachinery.pkg.apis.meta.v1.Time lastHeartbeatTime = 3

  Last time we got an update on a given condition. +optional

• optional apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 4

  Last time the condition transit from one status to another. +optional

• optional string reason = 5

  (brief) reason for the condition's last transition. +optional

• optional string message = 6

  Human readable message indicating details about last transition. +optional

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.

Used in: NodeConfigStatus, NodeSpec

• optional ConfigMapNodeConfigSource configMap = 2

  ConfigMap is a reference to a Node's ConfigMap

NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.

Used in: NodeStatus

• optional NodeConfigSource assigned = 1

  Assigned reports the checkpointed config the node will try to use. When Node.Spec.ConfigSource is updated, the node checkpoints the associated config payload to local disk, along with a record indicating intended config. The node refers to this record to choose its config checkpoint, and reports this record in Assigned. Assigned only updates in the status after the record has been checkpointed to disk. When the Kubelet is restarted, it tries to make the Assigned config the Active config by loading and validating the checkpointed payload identified by Assigned. +optional

• optional NodeConfigSource active = 2

  Active reports the checkpointed config the node is actively using. Active will represent either the current version of the Assigned config, or the current LastKnownGood config, depending on whether attempting to use the Assigned config results in an error. +optional

• optional NodeConfigSource lastKnownGood = 3

  LastKnownGood reports the checkpointed config the node will fall back to when it encounters an error attempting to use the Assigned config. The Assigned config becomes the LastKnownGood config when the node determines that the Assigned config is stable and correct. This is currently implemented as a 10-minute soak period starting when the local record of Assigned config is updated. If the Assigned config is Active at the end of this period, it becomes the LastKnownGood. Note that if Spec.ConfigSource is reset to nil (use local defaults), the LastKnownGood is also immediately reset to nil, because the local default config is always assumed good. You should not make assumptions about the node's method of determining config stability and correctness, as this may change or become configurable in the future. +optional

• optional string error = 4

  Error describes any problems reconciling the Spec.ConfigSource to the Active config. Errors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned record, attempting to checkpoint the payload associated with Spec.ConfigSource, attempting to load or validate the Assigned config, etc. Errors may occur at different points while syncing config. Earlier errors (e.g. download or checkpointing errors) will not result in a rollback to LastKnownGood, and may resolve across Kubelet retries. Later errors (e.g. loading or validating a checkpointed config) will result in a rollback to LastKnownGood. In the latter case, it is usually possible to resolve the error by fixing the config assigned in Spec.ConfigSource. You can find additional information for debugging by searching the error message in the Kubelet log. Error is a human-readable description of the error state; machines can check whether or not Error is empty, but should not rely on the stability of the Error text across Kubelet versions. +optional

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

Used in: NodeStatus

• optional DaemonEndpoint kubeletEndpoint = 1

  Endpoint on which Kubelet is listening. +optional

NodeList is the whole list of all Nodes which have been registered with master.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• repeated Node items = 2

  List of nodes

NodeProxyOptions is the query options to a Node's proxy call.

• optional string path = 1

  Path is the URL path to use for the current proxy request to node. +optional

NodeResources is an object for conveying resource information about a node. see https://kubernetes.io/docs/concepts/architecture/nodes/#capacity for more details.

• map<string, apimachinery.pkg.api.resource.Quantity> capacity = 1

  Capacity represents the available resources of a node

A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.

Used in: NodeAffinity, VolumeNodeAffinity

• repeated NodeSelectorTerm nodeSelectorTerms = 1

  Required. A list of node selector terms. The terms are ORed.

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

Used in: NodeSelectorTerm

• optional string key = 1

  The label key that the selector applies to.

• optional string operator = 2

  Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

• repeated string values = 3

  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. +optional

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.

Used in: NodeSelector, PreferredSchedulingTerm

• repeated NodeSelectorRequirement matchExpressions = 1

  A list of node selector requirements by node's labels. +optional

• repeated NodeSelectorRequirement matchFields = 2

  A list of node selector requirements by node's fields. +optional

NodeSpec describes the attributes that a node is created with.

Used in: Node

• optional string podCIDR = 1

  PodCIDR represents the pod IP range assigned to the node. +optional

• repeated string podCIDRs = 7

  podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6. +optional +patchStrategy=merge

• optional string providerID = 3

  ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID> +optional

• optional bool unschedulable = 4

  Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration +optional

• repeated Taint taints = 5

  If specified, the node's taints. +optional

• optional NodeConfigSource configSource = 6

  If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field +optional

• optional string externalID = 2

  Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966 +optional

NodeStatus is information about the current status of a node.

Used in: Node

• map<string, apimachinery.pkg.api.resource.Quantity> capacity = 1

  Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity +optional

• map<string, apimachinery.pkg.api.resource.Quantity> allocatable = 2

  Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity. +optional

• optional string phase = 3

  NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated. +optional

• repeated NodeCondition conditions = 4

  Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition +optional +patchMergeKey=type +patchStrategy=merge

• repeated NodeAddress addresses = 5

  List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See http://pr.k8s.io/79391 for an example. +optional +patchMergeKey=type +patchStrategy=merge

• optional NodeDaemonEndpoints daemonEndpoints = 6

  Endpoints of daemons running on the Node. +optional

• optional NodeSystemInfo nodeInfo = 7

  Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info +optional

• repeated ContainerImage images = 8

  List of container images on this node +optional

• repeated string volumesInUse = 9

  List of attachable volumes in use (mounted) by the node. +optional

• repeated AttachedVolume volumesAttached = 10

  List of volumes that are attached to the node. +optional

• optional NodeConfigStatus config = 11

  Status of the config assigned to the node via the dynamic Kubelet config feature. +optional

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

Used in: NodeStatus

• optional string machineID = 1

  MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html

• optional string systemUUID = 2

  SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid

• optional string bootID = 3

  Boot ID reported by the node.

• optional string kernelVersion = 4

  Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).

• optional string osImage = 5

  OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).

• optional string containerRuntimeVersion = 6

  ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).

• optional string kubeletVersion = 7

  Kubelet Version reported by the node.

• optional string kubeProxyVersion = 8

  KubeProxy Version reported by the node.

• optional string operatingSystem = 9

  The Operating System reported by the node

• optional string architecture = 10

  The Architecture reported by the node

ObjectFieldSelector selects an APIVersioned field of an object.

Used in: DownwardAPIVolumeFile, EnvVarSource

• optional string apiVersion = 1

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

• optional string fieldPath = 2

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

ObjectReference contains enough information to let you inspect or modify the referred object. --- New uses of this type are discouraged because of difficulty describing its usage when embedded in APIs. 1. Ignored fields. It includes many fields which are not generally honored. For instance, ResourceVersion and FieldPath are both very rarely valid in actual usage. 2. Invalid usage help. It is impossible to add specific help for individual usage. In most embedded usages, there are particular restrictions like, "must refer only to types A and B" or "UID not honored" or "name must be restricted". Those cannot be well described when embedded. 3. Inconsistent validation. Because the usages are different, the validation rules are different by usage, which makes it hard for users to predict what will happen. 4. The fields are both imprecise and overly precise. Kind is not a precise mapping to a URL. This can produce ambiguity during interpretation and require a REST mapping. In most cases, the dependency is on the group,resource tuple and the version of the actual struct is irrelevant. 5. We cannot easily change it. Because this type is embedded in many locations, updates to this type will affect numerous schemas. Don't make new APIs embed an underspecified API type they do not control. Instead of using this type, create a locally provided and used type that is well-focused on your reference. For example, ServiceReferences for admission registration: https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533 . +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

Used in: Binding, EndpointAddress, Event, PersistentVolumeSpec, SerializedReference, ServiceAccount, StorageOSPersistentVolumeSource

• optional string kind = 1

  Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• optional string namespace = 2

  Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ +optional

• optional string name = 3

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

• optional string uid = 4

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

• optional string apiVersion = 5

  API version of the referent. +optional

• optional string resourceVersion = 6

  Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional

• optional string fieldPath = 7

  If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. +optional

PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes

Used in: PersistentVolumeList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional PersistentVolumeSpec spec = 2

  Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes +optional

• optional PersistentVolumeStatus status = 3

  Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes +optional

PersistentVolumeClaim is a user's request for and claim to a persistent volume

Used in: PersistentVolumeClaimList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional PersistentVolumeClaimSpec spec = 2

  Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims +optional

• optional PersistentVolumeClaimStatus status = 3

  Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims +optional

PersistentVolumeClaimCondition contails details about state of pvc

Used in: PersistentVolumeClaimStatus

• optional string type = 1

• optional string status = 2

• optional apimachinery.pkg.apis.meta.v1.Time lastProbeTime = 3

  Last time we probed the condition. +optional

• optional apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 4

  Last time the condition transitioned from one status to another. +optional

• optional string reason = 5

  Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized. +optional

• optional string message = 6

  Human-readable message indicating details about last transition. +optional

PersistentVolumeClaimList is a list of PersistentVolumeClaim items.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• repeated PersistentVolumeClaim items = 2

  A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

Used in: PersistentVolumeClaim, PersistentVolumeClaimTemplate

• repeated string accessModes = 1

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

• optional apimachinery.pkg.apis.meta.v1.LabelSelector selector = 4

  A label query over volumes to consider for binding. +optional

• optional ResourceRequirements resources = 2

  Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources +optional

• optional string volumeName = 3

  VolumeName is the binding reference to the PersistentVolume backing this claim. +optional

• optional string storageClassName = 5

  Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 +optional

• optional string volumeMode = 6

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

• optional TypedLocalObjectReference dataSource = 7

  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. +optional

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

Used in: PersistentVolumeClaim

• optional string phase = 1

  Phase represents the current phase of PersistentVolumeClaim. +optional

• repeated string accessModes = 2

  AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 +optional

• map<string, apimachinery.pkg.api.resource.Quantity> capacity = 3

  Represents the actual resources of the underlying volume. +optional

• repeated PersistentVolumeClaimCondition conditions = 4

  Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'. +optional +patchMergeKey=type +patchStrategy=merge

PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.

Used in: EphemeralVolumeSource

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  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. +optional

• optional PersistentVolumeClaimSpec spec = 2

  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.

PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

Used in: VolumeSource

• optional string claimName = 1

  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

• optional bool readOnly = 2

  Will force the ReadOnly setting in VolumeMounts. Default false. +optional

PersistentVolumeList is a list of PersistentVolume items.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• repeated PersistentVolume items = 2

  List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes

PersistentVolumeSource is similar to VolumeSource but meant for the administrator who creates PVs. Exactly one of its members must be set.

Used in: PersistentVolumeSpec

• optional GCEPersistentDiskVolumeSource gcePersistentDisk = 1

  GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk +optional

• optional AWSElasticBlockStoreVolumeSource awsElasticBlockStore = 2

  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 +optional

• optional HostPathVolumeSource hostPath = 3

  HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath +optional

• optional GlusterfsPersistentVolumeSource glusterfs = 4

  Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md +optional

• optional NFSVolumeSource nfs = 5

  NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs +optional

• optional RBDPersistentVolumeSource rbd = 6

  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 +optional

• optional ISCSIPersistentVolumeSource iscsi = 7

  ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. +optional

• optional CinderPersistentVolumeSource cinder = 8

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

• optional CephFSPersistentVolumeSource cephfs = 9

  CephFS represents a Ceph FS mount on the host that shares a pod's lifetime +optional

• optional FCVolumeSource fc = 10

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

• optional FlockerVolumeSource flocker = 11

  Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running +optional

• optional FlexPersistentVolumeSource flexVolume = 12

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

• optional AzureFilePersistentVolumeSource azureFile = 13

  AzureFile represents an Azure File Service mount on the host and bind mount to the pod. +optional

• optional VsphereVirtualDiskVolumeSource vsphereVolume = 14

  VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine +optional

• optional QuobyteVolumeSource quobyte = 15

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

• optional AzureDiskVolumeSource azureDisk = 16

  AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. +optional

• optional PhotonPersistentDiskVolumeSource photonPersistentDisk = 17

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

• optional PortworxVolumeSource portworxVolume = 18

  PortworxVolume represents a portworx volume attached and mounted on kubelets host machine +optional

• optional ScaleIOPersistentVolumeSource scaleIO = 19

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

• optional LocalVolumeSource local = 20

  Local represents directly-attached storage with node affinity +optional

• optional StorageOSPersistentVolumeSource storageos = 21

  StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md +optional

• optional CSIPersistentVolumeSource csi = 22

  CSI represents storage that is handled by an external CSI driver (Beta feature). +optional

PersistentVolumeSpec is the specification of a persistent volume.

Used in: PersistentVolume

• map<string, apimachinery.pkg.api.resource.Quantity> capacity = 1

  A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity +optional

• optional PersistentVolumeSource persistentVolumeSource = 2

  The actual volume backing the persistent volume.

• repeated string accessModes = 3

  AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes +optional

• optional ObjectReference claimRef = 4

  ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding +optional

• optional string persistentVolumeReclaimPolicy = 5

  What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming +optional

• optional string storageClassName = 6

  Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. +optional

• repeated string mountOptions = 7

  A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options +optional

• optional string volumeMode = 8

  volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. +optional

• optional VolumeNodeAffinity nodeAffinity = 9

  NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume. +optional

PersistentVolumeStatus is the current status of a persistent volume.

Used in: PersistentVolume

• optional string phase = 1

  Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase +optional

• optional string message = 2

  A human-readable message indicating details about why the volume is in this state. +optional

• optional string reason = 3

  Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI. +optional

Represents a Photon Controller persistent disk resource.

Used in: PersistentVolumeSource, VolumeSource

• optional string pdID = 1

  ID that identifies Photon Controller persistent disk

• optional string fsType = 2

  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.

Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.

Used in: PodList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional PodSpec spec = 2

  Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

• optional PodStatus status = 3

  Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

Pod affinity is a group of inter pod affinity scheduling rules.

Used in: Affinity

• repeated PodAffinityTerm requiredDuringSchedulingIgnoredDuringExecution = 1

  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. +optional

• repeated WeightedPodAffinityTerm preferredDuringSchedulingIgnoredDuringExecution = 2

  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. +optional

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

Used in: PodAffinity, PodAntiAffinity, WeightedPodAffinityTerm

• optional apimachinery.pkg.apis.meta.v1.LabelSelector labelSelector = 1

  A label query over a set of resources, in this case pods. +optional

• repeated string namespaces = 2

  namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace" +optional

• optional string topologyKey = 3

  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.

Pod anti affinity is a group of inter pod anti affinity scheduling rules.

Used in: Affinity

• repeated PodAffinityTerm requiredDuringSchedulingIgnoredDuringExecution = 1

  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. +optional

• repeated WeightedPodAffinityTerm preferredDuringSchedulingIgnoredDuringExecution = 2

  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. +optional

PodAttachOptions is the query options to a Pod's remote attach call. --- TODO: merge w/ PodExecOptions below for stdin, stdout, etc and also when we cut V2, we should export a "StreamOptions" or somesuch that contains Stdin, Stdout, Stder and TTY

• optional bool stdin = 1

  Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. +optional

• optional bool stdout = 2

  Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. +optional

• optional bool stderr = 3

  Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. +optional

• optional bool tty = 4

  TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. +optional

• optional string container = 5

  The container in which to execute the command. Defaults to only container if there is only one container in the pod. +optional

PodCondition contains details for the current condition of this pod.

Used in: PodStatus

• optional string type = 1

  Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

• optional string status = 2

  Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

• optional apimachinery.pkg.apis.meta.v1.Time lastProbeTime = 3

  Last time we probed the condition. +optional

• optional apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 4

  Last time the condition transitioned from one status to another. +optional

• optional string reason = 5

  Unique, one-word, CamelCase reason for the condition's last transition. +optional

• optional string message = 6

  Human-readable message indicating details about last transition. +optional

PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

Used in: PodSpec

• repeated string nameservers = 1

  A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. +optional

• repeated string searches = 2

  A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. +optional

• repeated PodDNSConfigOption options = 3

  A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. +optional

PodDNSConfigOption defines DNS resolver options of a pod.

Used in: PodDNSConfig

• optional string name = 1

  Required.

• optional string value = 2

  +optional

PodExecOptions is the query options to a Pod's remote exec call. --- TODO: This is largely identical to PodAttachOptions above, make sure they stay in sync and see about merging and also when we cut V2, we should export a "StreamOptions" or somesuch that contains Stdin, Stdout, Stder and TTY

• optional bool stdin = 1

  Redirect the standard input stream of the pod for this call. Defaults to false. +optional

• optional bool stdout = 2

  Redirect the standard output stream of the pod for this call. Defaults to true. +optional

• optional bool stderr = 3

  Redirect the standard error stream of the pod for this call. Defaults to true. +optional

• optional bool tty = 4

  TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. +optional

• optional string container = 5

  Container in which to execute the command. Defaults to only container if there is only one container in the pod. +optional

• repeated string command = 6

  Command is the remote command to execute. argv array. Not executed within a shell.

IP address information for entries in the (plural) PodIPs field. Each entry includes: IP: An IP address allocated to the pod. Routable at least within the cluster.

Used in: PodStatus

• optional string ip = 1

  ip is an IP address (IPv4 or IPv6) assigned to the pod

PodList is a list of Pods.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• repeated Pod items = 2

  List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

PodLogOptions is the query options for a Pod's logs REST call.

• optional string container = 1

  The container for which to stream logs. Defaults to only container if there is one container in the pod. +optional

• optional bool follow = 2

  Follow the log stream of the pod. Defaults to false. +optional

• optional bool previous = 3

  Return previous terminated container logs. Defaults to false. +optional

• optional int64 sinceSeconds = 4

  A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. +optional

• optional apimachinery.pkg.apis.meta.v1.Time sinceTime = 5

  An RFC3339 timestamp from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. +optional

• optional bool timestamps = 6

  If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. +optional

• optional int64 tailLines = 7

  If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime +optional

• optional int64 limitBytes = 8

  If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. +optional

• optional bool insecureSkipTLSVerifyBackend = 9

  insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver's TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). +optional

PodPortForwardOptions is the query options to a Pod's port forward call when using WebSockets. The `port` query parameter must specify the port or ports (comma separated) to forward over. Port forwarding over SPDY does not use these options. It requires the port to be passed in the `port` header as part of request.

• repeated int32 ports = 1

  List of ports to forward Required when using WebSockets +optional

PodProxyOptions is the query options to a Pod's proxy call.

• optional string path = 1

  Path is the URL path to use for the current proxy request to pod. +optional

PodReadinessGate contains the reference to a pod condition

Used in: PodSpec

• optional string conditionType = 1

  ConditionType refers to a condition in the pod's condition list with matching type.

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

Used in: PodSpec

• optional SELinuxOptions seLinuxOptions = 1

  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. +optional

• optional WindowsSecurityContextOptions windowsOptions = 8

  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. +optional

• optional int64 runAsUser = 2

  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. +optional

• optional int64 runAsGroup = 6

  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. +optional

• optional bool runAsNonRoot = 3

  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. +optional

• repeated int64 supplementalGroups = 4

  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. +optional

• optional int64 fsGroup = 5

  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: 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---- If unset, the Kubelet will not modify the ownership and permissions of any volume. +optional

• repeated Sysctl sysctls = 7

  Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. +optional

• optional string fsGroupChangePolicy = 9

  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. +optional

• optional SeccompProfile seccompProfile = 10

  The seccomp options to use by the containers in this pod. +optional

Describes the class of pods that should avoid this node. Exactly one field should be set.

Used in: PreferAvoidPodsEntry

• optional apimachinery.pkg.apis.meta.v1.OwnerReference podController = 1

  Reference to controller whose pods should avoid this node. +optional

PodSpec is a description of a pod.

Used in: Pod, PodTemplateSpec

• repeated Volume volumes = 1

  List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes +optional +patchMergeKey=name +patchStrategy=merge,retainKeys

• repeated Container initContainers = 20

  List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ +patchMergeKey=name +patchStrategy=merge

• repeated Container containers = 2

  List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. +patchMergeKey=name +patchStrategy=merge

• repeated EphemeralContainer ephemeralContainers = 34

  List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. +optional +patchMergeKey=name +patchStrategy=merge

• optional string restartPolicy = 3

  Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy +optional

• optional int64 terminationGracePeriodSeconds = 4

  Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. +optional

• optional int64 activeDeadlineSeconds = 5

  Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. +optional

• optional string dnsPolicy = 6

  Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. +optional

• map<string, string> nodeSelector = 7

  NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ +optional

• optional string serviceAccountName = 8

  ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ +optional

• optional string serviceAccount = 9

  DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. +k8s:conversion-gen=false +optional

• optional bool automountServiceAccountToken = 21

  AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. +optional

• optional string nodeName = 10

  NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. +optional

• optional bool hostNetwork = 11

  Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. +k8s:conversion-gen=false +optional

• optional bool hostPID = 12

  Use the host's pid namespace. Optional: Default to false. +k8s:conversion-gen=false +optional

• optional bool hostIPC = 13

  Use the host's ipc namespace. Optional: Default to false. +k8s:conversion-gen=false +optional

• optional bool shareProcessNamespace = 27

  Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. +k8s:conversion-gen=false +optional

• optional PodSecurityContext securityContext = 14

  SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. +optional

• repeated LocalObjectReference imagePullSecrets = 15

  ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod +optional +patchMergeKey=name +patchStrategy=merge

• optional string hostname = 16

  Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. +optional

• optional string subdomain = 17

  If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all. +optional

• optional Affinity affinity = 18

  If specified, the pod's scheduling constraints +optional

• optional string schedulerName = 19

  If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. +optional

• repeated Toleration tolerations = 22

  If specified, the pod's tolerations. +optional

• repeated HostAlias hostAliases = 23

  HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. +optional +patchMergeKey=ip +patchStrategy=merge

• optional string priorityClassName = 24

  If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. +optional

• optional int32 priority = 25

  The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. +optional

• optional PodDNSConfig dnsConfig = 26

  Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. +optional

• repeated PodReadinessGate readinessGates = 28

  If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md +optional

• optional string runtimeClassName = 29

  RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14. +optional

• optional bool enableServiceLinks = 30

  EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true. +optional

• optional string preemptionPolicy = 31

  PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. +optional

• map<string, apimachinery.pkg.api.resource.Quantity> overhead = 32

  Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature. +optional

• repeated TopologySpreadConstraint topologySpreadConstraints = 33

  TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. +optional +patchMergeKey=topologyKey +patchStrategy=merge +listType=map +listMapKey=topologyKey +listMapKey=whenUnsatisfiable

• optional bool setHostnameAsFQDN = 35

  If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false. +optional

PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot contact the control plane.

Used in: Pod, PodStatusResult

• optional string phase = 1

  The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values: Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase +optional

• repeated PodCondition conditions = 2

  Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions +optional +patchMergeKey=type +patchStrategy=merge

• optional string message = 3

  A human readable message indicating details about why the pod is in this condition. +optional

• optional string reason = 4

  A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted' +optional

• optional string nominatedNodeName = 11

  nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled. +optional

• optional string hostIP = 5

  IP address of the host to which the pod is assigned. Empty if not yet scheduled. +optional

• optional string podIP = 6

  IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated. +optional

• repeated PodIP podIPs = 12

  podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet. +optional +patchStrategy=merge +patchMergeKey=ip

• optional apimachinery.pkg.apis.meta.v1.Time startTime = 7

  RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod. +optional

• repeated ContainerStatus initContainerStatuses = 10

  The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

• repeated ContainerStatus containerStatuses = 8

  The list has one entry per container in the manifest. Each entry is currently the output of `docker inspect`. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status +optional

• optional string qosClass = 9

  The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md +optional

• repeated ContainerStatus ephemeralContainerStatuses = 13

  Status for any ephemeral containers that have run in this pod. This field is alpha-level and is only populated by servers that enable the EphemeralContainers feature. +optional

PodStatusResult is a wrapper for PodStatus returned by kubelet that can be encode/decoded

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional PodStatus status = 2

  Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

PodTemplate describes a template for creating copies of a predefined pod.

Used in: PodTemplateList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional PodTemplateSpec template = 2

  Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

PodTemplateList is a list of PodTemplates.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• repeated PodTemplate items = 2

  List of pod templates

PodTemplateSpec describes the data a pod should have when created from a template

Used in: PodTemplate, ReplicationControllerSpec

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional PodSpec spec = 2

  Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

Used in: LoadBalancerIngress

• optional int32 port = 1

  Port is the port number of the service port of which status is recorded here

• optional string protocol = 2

  Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"

• optional string error = 3

  Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use CamelCase names - cloud provider specific error values must have names that comply with the format foo.example.com/CamelCase. --- The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) +optional +kubebuilder:validation:Required +kubebuilder:validation:Pattern=`^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$` +kubebuilder:validation:MaxLength=316

PortworxVolumeSource represents a Portworx volume resource.

Used in: PersistentVolumeSource, VolumeSource

• optional string volumeID = 1

  VolumeID uniquely identifies a Portworx volume

• optional string fsType = 2

  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.

• optional bool readOnly = 3

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

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out. +k8s:openapi-gen=false

• optional string uid = 1

  Specifies the target UID. +optional

Describes a class of pods that should avoid this node.

Used in: AvoidPods

• optional PodSignature podSignature = 1

  The class of pods.

• optional apimachinery.pkg.apis.meta.v1.Time evictionTime = 2

  Time at which this entry was added to the list. +optional

• optional string reason = 3

  (brief) reason why this entry was added to the list. +optional

• optional string message = 4

  Human readable message indicating why this entry was added to the list. +optional

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).

Used in: NodeAffinity

• optional int32 weight = 1

  Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

• optional NodeSelectorTerm preference = 2

  A node selector term, associated with the corresponding weight.

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Used in: Container, EphemeralContainerCommon

• optional Handler handler = 1

  The action taken to determine the health of a container

• optional int32 initialDelaySeconds = 2

  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 +optional

• optional int32 timeoutSeconds = 3

  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 +optional

• optional int32 periodSeconds = 4

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

• optional int32 successThreshold = 5

  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. +optional

• optional int32 failureThreshold = 6

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

Represents a projected volume source

Used in: VolumeSource

• repeated VolumeProjection sources = 1

  list of volume projections +optional

• optional int32 defaultMode = 2

  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. +optional

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

Used in: PersistentVolumeSource, VolumeSource

• optional string registry = 1

  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

• optional string volume = 2

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

• optional bool readOnly = 3

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

• optional string user = 4

  User to map volume access to Defaults to serivceaccount user +optional

• optional string group = 5

  Group to map volume access to Default is no group +optional

• optional string tenant = 6

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

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

Used in: PersistentVolumeSource

• repeated string monitors = 1

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

• optional string image = 2

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

• optional string fsType = 3

  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 +optional

• optional string pool = 4

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

• optional string user = 5

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

• optional string keyring = 6

  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 +optional

• optional SecretReference secretRef = 7

  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 +optional

• optional bool readOnly = 8

  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 +optional

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

Used in: VolumeSource

• repeated string monitors = 1

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

• optional string image = 2

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

• optional string fsType = 3

  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 +optional

• optional string pool = 4

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

• optional string user = 5

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

• optional string keyring = 6

  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 +optional

• optional LocalObjectReference secretRef = 7

  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 +optional

• optional bool readOnly = 8

  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 +optional

RangeAllocation is not a public type.

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional string range = 2

  Range is string that identifies the range represented by 'data'.

• optional bytes data = 3

  Data is a bit array containing all allocated addresses in the previous segment.

ReplicationController represents the configuration of a replication controller.

Used in: ReplicationControllerList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional ReplicationControllerSpec spec = 2

  Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

• optional ReplicationControllerStatus status = 3

  Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

ReplicationControllerCondition describes the state of a replication controller at a certain point.

Used in: ReplicationControllerStatus

• optional string type = 1

  Type of replication controller condition.

• optional string status = 2

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

• optional apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3

  The last time the condition transitioned from one status to another. +optional

• optional string reason = 4

  The reason for the condition's last transition. +optional

• optional string message = 5

  A human readable message indicating details about the transition. +optional

ReplicationControllerList is a collection of replication controllers.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• repeated ReplicationController items = 2

  List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller

ReplicationControllerSpec is the specification of a replication controller.

Used in: ReplicationController

• optional int32 replicas = 1

  Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller +optional

• optional int32 minReadySeconds = 4

  Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) +optional

• map<string, string> selector = 2

  Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors +optional

• optional PodTemplateSpec template = 3

  Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template +optional

ReplicationControllerStatus represents the current status of a replication controller.

Used in: ReplicationController

• optional int32 replicas = 1

  Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller

• optional int32 fullyLabeledReplicas = 2

  The number of pods that have labels matching the labels of the pod template of the replication controller. +optional

• optional int32 readyReplicas = 4

  The number of ready replicas for this replication controller. +optional

• optional int32 availableReplicas = 5

  The number of available replicas (ready for at least minReadySeconds) for this replication controller. +optional

• optional int64 observedGeneration = 3

  ObservedGeneration reflects the generation of the most recently observed replication controller. +optional

• repeated ReplicationControllerCondition conditions = 6

  Represents the latest available observations of a replication controller's current state. +optional +patchMergeKey=type +patchStrategy=merge

ResourceFieldSelector represents container resources (cpu, memory) and their output format

Used in: DownwardAPIVolumeFile, EnvVarSource

• optional string containerName = 1

  Container name: required for volumes, optional for env vars +optional

• optional string resource = 2

  Required: resource to select

• optional apimachinery.pkg.api.resource.Quantity divisor = 3

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

ResourceQuota sets aggregate quota restrictions enforced per namespace

Used in: ResourceQuotaList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional ResourceQuotaSpec spec = 2

  Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

• optional ResourceQuotaStatus status = 3

  Status defines the actual enforced quota and its current usage. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

ResourceQuotaList is a list of ResourceQuota items.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• repeated ResourceQuota items = 2

  Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/

ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

Used in: ResourceQuota

• map<string, apimachinery.pkg.api.resource.Quantity> hard = 1

  hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ +optional

• repeated string scopes = 2

  A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. +optional

• optional ScopeSelector scopeSelector = 3

  scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched. +optional

ResourceQuotaStatus defines the enforced hard limits and observed use.

Used in: ResourceQuota

• map<string, apimachinery.pkg.api.resource.Quantity> hard = 1

  Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ +optional

• map<string, apimachinery.pkg.api.resource.Quantity> used = 2

  Used is the current observed total usage of the resource in the namespace. +optional

ResourceRequirements describes the compute resource requirements.

Used in: Container, EphemeralContainerCommon, PersistentVolumeClaimSpec

• map<string, apimachinery.pkg.api.resource.Quantity> limits = 1

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

• map<string, apimachinery.pkg.api.resource.Quantity> requests = 2

  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-resources-containers/ +optional

SELinuxOptions are the labels to be applied to the container

Used in: PodSecurityContext, SecurityContext

• optional string user = 1

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

• optional string role = 2

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

• optional string type = 3

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

• optional string level = 4

  Level is SELinux level label that applies to the container. +optional

ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume

Used in: PersistentVolumeSource

• optional string gateway = 1

  The host address of the ScaleIO API Gateway.

• optional string system = 2

  The name of the storage system as configured in ScaleIO.

• optional SecretReference secretRef = 3

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

• optional bool sslEnabled = 4

  Flag to enable/disable SSL communication with Gateway, default false +optional

• optional string protectionDomain = 5

  The name of the ScaleIO Protection Domain for the configured storage. +optional

• optional string storagePool = 6

  The ScaleIO Storage Pool associated with the protection domain. +optional

• optional string storageMode = 7

  Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. +optional

• optional string volumeName = 8

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

• optional string fsType = 9

  Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs" +optional

• optional bool readOnly = 10

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

ScaleIOVolumeSource represents a persistent ScaleIO volume

Used in: VolumeSource

• optional string gateway = 1

  The host address of the ScaleIO API Gateway.

• optional string system = 2

  The name of the storage system as configured in ScaleIO.

• optional LocalObjectReference secretRef = 3

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

• optional bool sslEnabled = 4

  Flag to enable/disable SSL communication with Gateway, default false +optional

• optional string protectionDomain = 5

  The name of the ScaleIO Protection Domain for the configured storage. +optional

• optional string storagePool = 6

  The ScaleIO Storage Pool associated with the protection domain. +optional

• optional string storageMode = 7

  Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. +optional

• optional string volumeName = 8

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

• optional string fsType = 9

  Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". +optional

• optional bool readOnly = 10

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

A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.

Used in: ResourceQuotaSpec

• repeated ScopedResourceSelectorRequirement matchExpressions = 1

  A list of scope selector requirements by scope of the resources. +optional

A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.

Used in: ScopeSelector

• optional string scopeName = 1

  The name of the scope that the selector applies to.

• optional string operator = 2

  Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.

• repeated string values = 3

  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. +optional

SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. +union

Used in: PodSecurityContext, SecurityContext

• optional string type = 1

  type indicates which kind of seccomp profile will be applied. Valid options are: 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. +unionDiscriminator

• optional string localhostProfile = 2

  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". +optional

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

Used in: SecretList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional bool immutable = 5

  Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. +optional

• map<string, bytes> data = 2

  Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 +optional

• map<string, string> stringData = 4

  stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API. +k8s:conversion-gen=false +optional

• optional string type = 3

  Used to facilitate programmatic handling of secret data. +optional

SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables.

Used in: EnvFromSource

• optional LocalObjectReference localObjectReference = 1

  The Secret to select from.

• optional bool optional = 2

  Specify whether the Secret must be defined +optional

SecretKeySelector selects a key of a Secret.

Used in: EnvVarSource

• optional LocalObjectReference localObjectReference = 1

  The name of the secret in the pod's namespace to select from.

• optional string key = 2

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

• optional bool optional = 3

  Specify whether the Secret or its key must be defined +optional

SecretList is a list of Secret.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• repeated Secret items = 2

  Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret

Adapts a secret into a projected volume. The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.

Used in: VolumeProjection

• optional LocalObjectReference localObjectReference = 1

• repeated KeyToPath items = 2

  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 '..'. +optional

• optional bool optional = 4

  Specify whether the Secret or its key must be defined +optional

SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

Used in: CSIPersistentVolumeSource, CephFSPersistentVolumeSource, CinderPersistentVolumeSource, FlexPersistentVolumeSource, ISCSIPersistentVolumeSource, RBDPersistentVolumeSource, ScaleIOPersistentVolumeSource

• optional string name = 1

  Name is unique within a namespace to reference a secret resource. +optional

• optional string namespace = 2

  Namespace defines the space within which the secret name must be unique. +optional

Adapts a Secret into a volume. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

Used in: VolumeSource

• optional string secretName = 1

  Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret +optional

• repeated KeyToPath items = 2

  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 '..'. +optional

• optional int32 defaultMode = 3

  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. +optional

• optional bool optional = 4

  Specify whether the Secret or its keys must be defined +optional

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

Used in: Container, EphemeralContainerCommon

• optional Capabilities capabilities = 1

  The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. +optional

• optional bool privileged = 2

  Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. +optional

• optional SELinuxOptions seLinuxOptions = 3

  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. +optional

• optional WindowsSecurityContextOptions windowsOptions = 10

  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. +optional

• optional int64 runAsUser = 4

  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. +optional

• optional int64 runAsGroup = 8

  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. +optional

• optional bool runAsNonRoot = 5

  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. +optional

• optional bool readOnlyRootFilesystem = 6

  Whether this container has a read-only root filesystem. Default is false. +optional

• optional bool allowPrivilegeEscalation = 7

  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 +optional

• optional string procMount = 9

  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. +optional

• optional SeccompProfile seccompProfile = 11

  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. +optional

SerializedReference is a reference to serialized object.

• optional ObjectReference reference = 1

  The reference to an object in the system. +optional

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

Used in: ServiceList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional ServiceSpec spec = 2

  Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

• optional ServiceStatus status = 3

  Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets

Used in: ServiceAccountList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• repeated ObjectReference secrets = 2

  Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret +optional +patchMergeKey=name +patchStrategy=merge

• repeated LocalObjectReference imagePullSecrets = 3

  ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod +optional

• optional bool automountServiceAccountToken = 4

  AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level. +optional

ServiceAccountList is a list of ServiceAccount objects

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• repeated ServiceAccount items = 2

  List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).

Used in: VolumeProjection

• optional string audience = 1

  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. +optional

• optional int64 expirationSeconds = 2

  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. +optional

• optional string path = 3

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

ServiceList holds a list of services.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

• repeated Service items = 2

  List of services

ServicePort contains information on service's port.

Used in: ServiceSpec

• optional string name = 1

  The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. +optional

• optional string protocol = 2

  The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. +optional

• optional string appProtocol = 6

  The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default. +optional

• optional int32 port = 3

  The port that will be exposed by this service.

• optional apimachinery.pkg.util.intstr.IntOrString targetPort = 4

  Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service +optional

• optional int32 nodePort = 5

  The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport +optional

ServiceProxyOptions is the query options to a Service's proxy call.

• optional string path = 1

  Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. +optional

ServiceSpec describes the attributes that a user creates on a service.

Used in: Service

• repeated ServicePort ports = 1

  The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies +patchMergeKey=port +patchStrategy=merge +listType=map +listMapKey=port +listMapKey=protocol

• map<string, string> selector = 2

  Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/ +optional

• optional string clusterIP = 3

  clusterIP is the IP address of the service and is usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be blank) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies +optional

• repeated string clusterIPs = 18

  ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be empty) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. If this field is not specified, it will be initialized from the clusterIP field. If this field is specified, clients must ensure that clusterIPs[0] and clusterIP have the same value. Unless the "IPv6DualStack" feature gate is enabled, this field is limited to one value, which must be the same as the clusterIP field. If the feature gate is enabled, this field may hold a maximum of two entries (dual-stack IPs, in either order). These IPs must correspond to the values of the ipFamilies field. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies +listType=atomic +optional

• optional string type = 4

  type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types +optional

• repeated string externalIPs = 5

  externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. +optional

• optional string sessionAffinity = 7

  Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies +optional

• optional string loadBalancerIP = 8

  Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. +optional

• repeated string loadBalancerSourceRanges = 9

  If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/ +optional

• optional string externalName = 10

  externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName". +optional

• optional string externalTrafficPolicy = 11

  externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading. +optional

• optional int32 healthCheckNodePort = 12

  healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). +optional

• optional bool publishNotReadyAddresses = 13

  publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. The primary use case for setting this field is for a StatefulSet's Headless Service to propagate SRV DNS records for its Pods for the purpose of peer discovery. The Kubernetes controllers that generate Endpoints and EndpointSlice resources for Services interpret this to mean that all endpoints are considered "ready" even if the Pods themselves are not. Agents which consume only Kubernetes generated endpoints through the Endpoints or EndpointSlice resources can safely assume this behavior. +optional

• optional SessionAffinityConfig sessionAffinityConfig = 14

  sessionAffinityConfig contains the configurations of session affinity. +optional

• repeated string topologyKeys = 16

  topologyKeys is a preference-order list of topology keys which implementations of services should use to preferentially sort endpoints when accessing this Service, it can not be used at the same time as externalTrafficPolicy=Local. Topology keys must be valid label keys and at most 16 keys may be specified. Endpoints are chosen based on the first topology key with available backends. If this field is specified and all entries have no backends that match the topology of the client, the service has no backends for that client and connections should fail. The special value "*" may be used to mean "any topology". This catch-all value, if used, only makes sense as the last value in the list. If this is not specified or empty, no topology constraints will be applied. This field is alpha-level and is only honored by servers that enable the ServiceTopology feature. This field is deprecated and will be removed in a future version. +optional

• repeated string ipFamilies = 19

  IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service, and is gated by the "IPv6DualStack" feature gate. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. +listType=atomic +optional

• optional string ipFamilyPolicy = 17

  IPFamilyPolicy represents the dual-stack-ness requested or required by this Service, and is gated by the "IPv6DualStack" feature gate. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName. +optional

• optional bool allocateLoadBalancerNodePorts = 20

  allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. allocateLoadBalancerNodePorts may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. This field is alpha-level and is only honored by servers that enable the ServiceLBNodePortControl feature. +optional

ServiceStatus represents the current status of a service.

Used in: Service

• optional LoadBalancerStatus loadBalancer = 1

  LoadBalancer contains the current status of the load-balancer, if one is present. +optional

• repeated apimachinery.pkg.apis.meta.v1.Condition conditions = 2

  Current service state +optional +patchMergeKey=type +patchStrategy=merge +listType=map +listMapKey=type

SessionAffinityConfig represents the configurations of session affinity.

Used in: ServiceSpec

• optional ClientIPConfig clientIP = 1

  clientIP contains the configurations of Client IP based session affinity. +optional

Represents a StorageOS persistent volume resource.

Used in: PersistentVolumeSource

• optional string volumeName = 1

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

• optional string volumeNamespace = 2

  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. +optional

• optional string fsType = 3

  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. +optional

• optional bool readOnly = 4

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

• optional ObjectReference secretRef = 5

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

Represents a StorageOS persistent volume resource.

Used in: VolumeSource

• optional string volumeName = 1

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

• optional string volumeNamespace = 2

  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. +optional

• optional string fsType = 3

  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. +optional

• optional bool readOnly = 4

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

• optional LocalObjectReference secretRef = 5

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

Sysctl defines a kernel parameter to be set

Used in: PodSecurityContext

• optional string name = 1

  Name of a property to set

• optional string value = 2

  Value of a property to set

TCPSocketAction describes an action based on opening a socket

Used in: Handler

• optional apimachinery.pkg.util.intstr.IntOrString port = 1

  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.

• optional string host = 2

  Optional: Host name to connect to, defaults to the pod IP. +optional

The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.

Used in: NodeSpec

• optional string key = 1

  Required. The taint key to be applied to a node.

• optional string value = 2

  The taint value corresponding to the taint key. +optional

• optional string effect = 3

  Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.

• optional apimachinery.pkg.apis.meta.v1.Time timeAdded = 4

  TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. +optional

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

Used in: PodSpec

• optional string key = 1

  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. +optional

• optional string operator = 2

  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. +optional

• optional string value = 3

  Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. +optional

• optional string effect = 4

  Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. +optional

• optional int64 tolerationSeconds = 5

  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. +optional

A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.

Used in: TopologySelectorTerm

• optional string key = 1

  The label key that the selector applies to.

• repeated string values = 2

  An array of string values. One value must match the label to be selected. Each entry in Values is ORed.

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

• repeated TopologySelectorLabelRequirement matchLabelExpressions = 1

  A list of topology selector requirements by labels. +optional

TopologySpreadConstraint specifies how to spread matching pods among the given topology.

Used in: PodSpec

• optional int32 maxSkew = 1

  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.

• optional string topologyKey = 2

  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.

• optional string whenUnsatisfiable = 3

  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.

• optional apimachinery.pkg.apis.meta.v1.LabelSelector labelSelector = 4

  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. +optional

TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.

Used in: PersistentVolumeClaimSpec

• optional string apiGroup = 1

  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. +optional

• optional string kind = 2

  Kind is the type of resource being referenced

• optional string name = 3

  Name is the name of resource being referenced

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

Used in: PodSpec

• optional string name = 1

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

• optional VolumeSource volumeSource = 2

  VolumeSource represents the location and type of the mounted volume. If not specified, the Volume is implied to be an EmptyDir. This implied behavior is deprecated and will be removed in a future version.

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

Used in: Container, EphemeralContainerCommon

• optional string name = 1

  name must match the name of a persistentVolumeClaim in the pod

• optional string devicePath = 2

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

VolumeMount describes a mounting of a Volume within a container.

Used in: Container, EphemeralContainerCommon

• optional string name = 1

  This must match the Name of a Volume.

• optional bool readOnly = 2

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

• optional string mountPath = 3

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

• optional string subPath = 4

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

• optional string mountPropagation = 5

  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. +optional

• optional string subPathExpr = 6

  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. +optional

VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.

Used in: PersistentVolumeSpec

• optional NodeSelector required = 1

  Required specifies hard node constraints that must be met.

Projection that may be projected along with other supported volume types

Used in: ProjectedVolumeSource

• optional SecretProjection secret = 1

  information about the secret data to project +optional

• optional DownwardAPIProjection downwardAPI = 2

  information about the downwardAPI data to project +optional

• optional ConfigMapProjection configMap = 3

  information about the configMap data to project +optional

• optional ServiceAccountTokenProjection serviceAccountToken = 4

  information about the serviceAccountToken data to project +optional

Represents the source of a volume to mount. Only one of its members may be specified.

Used in: Volume

• optional HostPathVolumeSource hostPath = 1

  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. +optional

• optional EmptyDirVolumeSource emptyDir = 2

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

• optional GCEPersistentDiskVolumeSource gcePersistentDisk = 3

  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 +optional

• optional AWSElasticBlockStoreVolumeSource awsElasticBlockStore = 4

  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 +optional

• optional GitRepoVolumeSource gitRepo = 5

  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. +optional

• optional SecretVolumeSource secret = 6

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

• optional NFSVolumeSource nfs = 7

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

• optional ISCSIVolumeSource iscsi = 8

  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 +optional

• optional GlusterfsVolumeSource glusterfs = 9

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

• optional PersistentVolumeClaimVolumeSource persistentVolumeClaim = 10

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

• optional RBDVolumeSource rbd = 11

  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 +optional

• optional FlexVolumeSource flexVolume = 12

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

• optional CinderVolumeSource cinder = 13

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

• optional CephFSVolumeSource cephfs = 14

  CephFS represents a Ceph FS mount on the host that shares a pod's lifetime +optional

• optional FlockerVolumeSource flocker = 15

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

• optional DownwardAPIVolumeSource downwardAPI = 16

  DownwardAPI represents downward API about the pod that should populate this volume +optional

• optional FCVolumeSource fc = 17

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

• optional AzureFileVolumeSource azureFile = 18

  AzureFile represents an Azure File Service mount on the host and bind mount to the pod. +optional

• optional ConfigMapVolumeSource configMap = 19

  ConfigMap represents a configMap that should populate this volume +optional

• optional VsphereVirtualDiskVolumeSource vsphereVolume = 20

  VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine +optional

• optional QuobyteVolumeSource quobyte = 21

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

• optional AzureDiskVolumeSource azureDisk = 22

  AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. +optional

• optional PhotonPersistentDiskVolumeSource photonPersistentDisk = 23

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

• optional ProjectedVolumeSource projected = 26

  Items for all in one resources secrets, configmaps, and downward API

• optional PortworxVolumeSource portworxVolume = 24

  PortworxVolume represents a portworx volume attached and mounted on kubelets host machine +optional

• optional ScaleIOVolumeSource scaleIO = 25

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

• optional StorageOSVolumeSource storageos = 27

  StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. +optional

• optional CSIVolumeSource csi = 28

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

• optional EphemeralVolumeSource ephemeral = 29

  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. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time. +optional

Represents a vSphere volume resource.

Used in: PersistentVolumeSource, VolumeSource

• optional string volumePath = 1

  Path that identifies vSphere volume vmdk

• optional string fsType = 2

  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. +optional

• optional string storagePolicyName = 3

  Storage Policy Based Management (SPBM) profile name. +optional

• optional string storagePolicyID = 4

  Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. +optional

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Used in: PodAffinity, PodAntiAffinity

• optional int32 weight = 1

  weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

• optional PodAffinityTerm podAffinityTerm = 2

  Required. A pod affinity term, associated with the corresponding weight.

WindowsSecurityContextOptions contain Windows-specific options and credentials.

Used in: PodSecurityContext, SecurityContext

• optional string gmsaCredentialSpecName = 1

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

• optional string gmsaCredentialSpec = 2

  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. +optional

• optional string runAsUserName = 3

  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. +optional