generated.proto

Package : k8s.io.api.core.v1

Top

generated.proto

Table of Contents

AWSElasticBlockStoreVolumeSource

Field Type Label Description
volumeID string optional Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
fsType string optional 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
partition int32 optional 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
readOnly bool optional 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

Field Type Label Description
nodeAffinity k8s.io.api.core.v1.NodeAffinity optional Describes node affinity scheduling rules for the pod. +optional
podAffinity k8s.io.api.core.v1.PodAffinity optional Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). +optional
podAntiAffinity k8s.io.api.core.v1.PodAntiAffinity optional 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

Field Type Label Description
name string optional Name of the attached volume
devicePath string optional DevicePath represents the device path where the volume should be available

AvoidPods

Field Type Label Description
preferAvoidPods []k8s.io.api.core.v1.PreferAvoidPodsEntry repeated 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

AzureDiskVolumeSource

Field Type Label Description
diskName string optional The Name of the data disk in the blob storage
diskURI string optional The URI the data disk in the blob storage
cachingMode string optional Host Caching mode: None, Read Only, Read Write. +optional
fsType string optional 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
readOnly bool optional Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional
kind string optional 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

AzureFilePersistentVolumeSource

Field Type Label Description
secretName string optional the name of secret that contains Azure Storage Account Name and Key
shareName string optional Share Name
readOnly bool optional Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional
secretNamespace string optional the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod +optional

AzureFileVolumeSource

Field Type Label Description
secretName string optional the name of secret that contains Azure Storage Account Name and Key
shareName string optional Share Name
readOnly bool optional Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional

Binding

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
target k8s.io.api.core.v1.ObjectReference optional The target object that you want to bind to the standard object.

CSIPersistentVolumeSource

Field Type Label Description
driver string optional Driver is the name of the driver to use for this volume. Required.
volumeHandle string optional VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
readOnly bool optional Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write). +optional
fsType string optional Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. +optional
volumeAttributes []k8s.io.api.core.v1.CSIPersistentVolumeSource.VolumeAttributesEntry repeated Attributes of the volume to publish. +optional
controllerPublishSecretRef k8s.io.api.core.v1.SecretReference optional 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
nodeStageSecretRef k8s.io.api.core.v1.SecretReference optional 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
nodePublishSecretRef k8s.io.api.core.v1.SecretReference optional NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. +optional
controllerExpandSecretRef k8s.io.api.core.v1.SecretReference optional 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

CSIPersistentVolumeSource.VolumeAttributesEntry

Field Type Label Description
key string optional
value string optional

CSIVolumeSource

Field Type Label Description
driver string optional 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.
readOnly bool optional Specifies a read-only configuration for the volume. Defaults to false (read/write). +optional
fsType string optional 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
volumeAttributes []k8s.io.api.core.v1.CSIVolumeSource.VolumeAttributesEntry repeated VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. +optional
nodePublishSecretRef k8s.io.api.core.v1.LocalObjectReference optional NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. +optional

CSIVolumeSource.VolumeAttributesEntry

Field Type Label Description
key string optional
value string optional

Capabilities

Field Type Label Description
add []string repeated Added capabilities +optional
drop []string repeated Removed capabilities +optional

CephFSPersistentVolumeSource

Field Type Label Description
monitors []string repeated Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
path string optional Optional: Used as the mounted root, rather than the full Ceph tree, default is / +optional
user string optional 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
secretFile string optional 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
secretRef k8s.io.api.core.v1.SecretReference optional 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
readOnly bool optional 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

CephFSVolumeSource

Field Type Label Description
monitors []string repeated Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
path string optional Optional: Used as the mounted root, rather than the full Ceph tree, default is / +optional
user string optional 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
secretFile string optional 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
secretRef k8s.io.api.core.v1.LocalObjectReference optional 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
readOnly bool optional 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

CinderPersistentVolumeSource

Field Type Label Description
volumeID string optional volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
fsType string optional 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
readOnly bool optional 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
secretRef k8s.io.api.core.v1.SecretReference optional Optional: points to a secret object containing parameters used to connect to OpenStack. +optional

CinderVolumeSource

Field Type Label Description
volumeID string optional volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
fsType string optional 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
readOnly bool optional 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
secretRef k8s.io.api.core.v1.LocalObjectReference optional Optional: points to a secret object containing parameters used to connect to OpenStack. +optional

ClientIPConfig

Field Type Label Description
timeoutSeconds int32 optional 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

ComponentCondition

Field Type Label Description
type string optional Type of condition for a component. Valid value: “Healthy”
status string optional Status of the condition for a component. Valid values for “Healthy”: “True”, “False”, or “Unknown”.
message string optional Message about the condition for a component. For example, information about a health check. +optional
error string optional Condition error code for a component. For example, a health check error code. +optional

ComponentStatus

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
conditions []k8s.io.api.core.v1.ComponentCondition repeated List of component conditions observed +optional +patchMergeKey=type +patchStrategy=merge

ComponentStatusList

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
items []k8s.io.api.core.v1.ComponentStatus repeated List of ComponentStatus objects.

ConfigMap

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
data []k8s.io.api.core.v1.ConfigMap.DataEntry repeated 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
binaryData []k8s.io.api.core.v1.ConfigMap.BinaryDataEntry repeated 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

ConfigMap.BinaryDataEntry

Field Type Label Description
key string optional
value bytes optional

ConfigMap.DataEntry

Field Type Label Description
key string optional
value string optional

ConfigMapEnvSource

Field Type Label Description
localObjectReference k8s.io.api.core.v1.LocalObjectReference optional The ConfigMap to select from.
optional bool optional Specify whether the ConfigMap must be defined +optional

ConfigMapKeySelector

Field Type Label Description
localObjectReference k8s.io.api.core.v1.LocalObjectReference optional The ConfigMap to select from.
key string optional The key to select.
optional bool optional Specify whether the ConfigMap or its key must be defined +optional

ConfigMapList

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
items []k8s.io.api.core.v1.ConfigMap repeated Items is the list of ConfigMaps.

ConfigMapNodeConfigSource

Field Type Label Description
namespace string optional Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
name string optional Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
uid string optional UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. +optional
resourceVersion string optional ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. +optional
kubeletConfigKey string optional KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.

ConfigMapProjection

Field Type Label Description
localObjectReference k8s.io.api.core.v1.LocalObjectReference optional
items []k8s.io.api.core.v1.KeyToPath repeated 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 Specify whether the ConfigMap or its keys must be defined +optional

ConfigMapVolumeSource

Field Type Label Description
localObjectReference k8s.io.api.core.v1.LocalObjectReference optional
items []k8s.io.api.core.v1.KeyToPath repeated 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
defaultMode int32 optional Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. 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 Specify whether the ConfigMap or its keys must be defined +optional

Container

Field Type Label Description
name string optional Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
image string optional 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
command []string repeated 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
args []string repeated 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
workingDir string optional Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. +optional
ports []k8s.io.api.core.v1.ContainerPort repeated 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
envFrom []k8s.io.api.core.v1.EnvFromSource repeated 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
env []k8s.io.api.core.v1.EnvVar repeated List of environment variables to set in the container. Cannot be updated. +optional +patchMergeKey=name +patchStrategy=merge
resources k8s.io.api.core.v1.ResourceRequirements optional Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional
volumeMounts []k8s.io.api.core.v1.VolumeMount repeated Pod volumes to mount into the container's filesystem. Cannot be updated. +optional +patchMergeKey=mountPath +patchStrategy=merge
volumeDevices []k8s.io.api.core.v1.VolumeDevice repeated volumeDevices is the list of block devices to be used by the container. This is a beta feature. +patchMergeKey=devicePath +patchStrategy=merge +optional
livenessProbe k8s.io.api.core.v1.Probe optional Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional
readinessProbe k8s.io.api.core.v1.Probe optional Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional
lifecycle k8s.io.api.core.v1.Lifecycle optional Actions that the management system should take in response to container lifecycle events. Cannot be updated. +optional
terminationMessagePath string optional Optional: Path at which the file to which the container's termination message will be written is mounted into the container's 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
terminationMessagePolicy string optional Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. +optional
imagePullPolicy string optional 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
securityContext k8s.io.api.core.v1.SecurityContext optional 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
stdin bool optional Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. +optional
stdinOnce bool optional Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false +optional
tty bool optional Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false. +optional

ContainerImage

Field Type Label Description
names []string repeated Names by which this image is known. e.g. [“k8s.gcr.io/hyperkube:v1.0.7”, “dockerhub.io/google_containers/hyperkube:v1.0.7”]
sizeBytes int64 optional The size of the image in bytes. +optional

ContainerPort

Field Type Label Description
name string optional If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. +optional
hostPort int32 optional Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. +optional
containerPort int32 optional Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
protocol string optional Protocol for port. Must be UDP, TCP, or SCTP. Defaults to “TCP”. +optional
hostIP string optional What host IP to bind the external port to. +optional

ContainerState

Field Type Label Description
waiting k8s.io.api.core.v1.ContainerStateWaiting optional Details about a waiting container +optional
running k8s.io.api.core.v1.ContainerStateRunning optional Details about a running container +optional
terminated k8s.io.api.core.v1.ContainerStateTerminated optional Details about a terminated container +optional

ContainerStateRunning

Field Type Label Description
startedAt k8s.io.apimachinery.pkg.apis.meta.v1.Time optional Time at which the container was last (re-)started +optional

ContainerStateTerminated

Field Type Label Description
exitCode int32 optional Exit status from the last termination of the container
signal int32 optional Signal from the last termination of the container +optional
reason string optional (brief) reason from the last termination of the container +optional
message string optional Message regarding the last termination of the container +optional
startedAt k8s.io.apimachinery.pkg.apis.meta.v1.Time optional Time at which previous execution of the container started +optional
finishedAt k8s.io.apimachinery.pkg.apis.meta.v1.Time optional Time at which the container last terminated +optional
containerID string optional Container's ID in the format ‘docker://<container_id>’ +optional

ContainerStateWaiting

Field Type Label Description
reason string optional (brief) reason the container is not yet running. +optional
message string optional Message regarding why the container is not yet running. +optional

ContainerStatus

Field Type Label Description
name string optional This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
state k8s.io.api.core.v1.ContainerState optional Details about the container's current condition. +optional
lastState k8s.io.api.core.v1.ContainerState optional Details about the container's last termination condition. +optional
ready bool optional Specifies whether the container has passed its readiness probe.
restartCount int32 optional 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.
image string optional The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images TODO(dchen1107): Which image the container is running with?
imageID string optional ImageID of the container's image.
containerID string optional Container's ID in the format ‘docker://<container_id>’. +optional

DaemonEndpoint

Field Type Label Description
port int32 optional Port number of the given endpoint.

DownwardAPIProjection

Field Type Label Description
items []k8s.io.api.core.v1.DownwardAPIVolumeFile repeated Items is a list of DownwardAPIVolume file +optional

DownwardAPIVolumeFile

Field Type Label Description
path string optional 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 ‘..’
fieldRef k8s.io.api.core.v1.ObjectFieldSelector optional Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. +optional
resourceFieldRef k8s.io.api.core.v1.ResourceFieldSelector optional Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. +optional
mode int32 optional Optional: mode bits to use on this file, must be a value between 0 and 0777. 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

Field Type Label Description
items []k8s.io.api.core.v1.DownwardAPIVolumeFile repeated Items is a list of downward API volume file +optional
defaultMode int32 optional Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. 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

EmptyDirVolumeSource

Field Type Label Description
medium string optional 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
sizeLimit k8s.io.apimachinery.pkg.api.resource.Quantity optional 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

Field Type Label Description
ip string optional 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.
hostname string optional The Hostname of this endpoint +optional
nodeName string optional Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node. +optional
targetRef k8s.io.api.core.v1.ObjectReference optional Reference to object providing the endpoint. +optional

EndpointPort

Field Type Label Description
name string optional 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
port int32 optional The port number of the endpoint.
protocol string optional The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. +optional

EndpointSubset

Field Type Label Description
addresses []k8s.io.api.core.v1.EndpointAddress repeated 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
notReadyAddresses []k8s.io.api.core.v1.EndpointAddress repeated 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
ports []k8s.io.api.core.v1.EndpointPort repeated Port numbers available on the related IP addresses. +optional

Endpoints

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
subsets []k8s.io.api.core.v1.EndpointSubset repeated 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

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
items []k8s.io.api.core.v1.Endpoints repeated List of endpoints.

EnvFromSource

Field Type Label Description
prefix string optional An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. +optional
configMapRef k8s.io.api.core.v1.ConfigMapEnvSource optional The ConfigMap to select from +optional
secretRef k8s.io.api.core.v1.SecretEnvSource optional The Secret to select from +optional

EnvVar

Field Type Label Description
name string optional Name of the environment variable. Must be a C_IDENTIFIER.
value string optional 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
valueFrom k8s.io.api.core.v1.EnvVarSource optional Source for the environment variable's value. Cannot be used if value is not empty. +optional

EnvVarSource

Field Type Label Description
fieldRef k8s.io.api.core.v1.ObjectFieldSelector optional Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP. +optional
resourceFieldRef k8s.io.api.core.v1.ResourceFieldSelector optional Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. +optional
configMapKeyRef k8s.io.api.core.v1.ConfigMapKeySelector optional Selects a key of a ConfigMap. +optional
secretKeyRef k8s.io.api.core.v1.SecretKeySelector optional Selects a key of a secret in the pod's namespace +optional

EphemeralContainer

Field Type Label Description
ephemeralContainerCommon k8s.io.api.core.v1.EphemeralContainerCommon optional
targetContainerName string optional 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

Field Type Label Description
name string optional Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.
image string optional Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images
command []string repeated 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
args []string repeated 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
workingDir string optional Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. +optional
ports []k8s.io.api.core.v1.ContainerPort repeated Ports are not allowed for ephemeral containers.
envFrom []k8s.io.api.core.v1.EnvFromSource repeated 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
env []k8s.io.api.core.v1.EnvVar repeated List of environment variables to set in the container. Cannot be updated. +optional +patchMergeKey=name +patchStrategy=merge
resources k8s.io.api.core.v1.ResourceRequirements optional Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod. +optional
volumeMounts []k8s.io.api.core.v1.VolumeMount repeated Pod volumes to mount into the container's filesystem. Cannot be updated. +optional +patchMergeKey=mountPath +patchStrategy=merge
volumeDevices []k8s.io.api.core.v1.VolumeDevice repeated volumeDevices is the list of block devices to be used by the container. This is a beta feature. +patchMergeKey=devicePath +patchStrategy=merge +optional
livenessProbe k8s.io.api.core.v1.Probe optional Probes are not allowed for ephemeral containers. +optional
readinessProbe k8s.io.api.core.v1.Probe optional Probes are not allowed for ephemeral containers. +optional
lifecycle k8s.io.api.core.v1.Lifecycle optional Lifecycle is not allowed for ephemeral containers. +optional
terminationMessagePath string optional Optional: Path at which the file to which the container's termination message will be written is mounted into the container's 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
terminationMessagePolicy string optional Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. +optional
imagePullPolicy string optional 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
securityContext k8s.io.api.core.v1.SecurityContext optional SecurityContext is not allowed for ephemeral containers. +optional
stdin bool optional Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. +optional
stdinOnce bool optional Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false +optional
tty bool optional Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false. +optional

EphemeralContainers

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional +optional
ephemeralContainers []k8s.io.api.core.v1.EphemeralContainer repeated The new set of ephemeral containers to use for a pod. +patchMergeKey=name +patchStrategy=merge

Event

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
involvedObject k8s.io.api.core.v1.ObjectReference optional The object that this event is about.
reason string optional 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
message string optional A human-readable description of the status of this operation. TODO: decide on maximum length. +optional
source k8s.io.api.core.v1.EventSource optional The component reporting this event. Should be a short machine understandable string. +optional
firstTimestamp k8s.io.apimachinery.pkg.apis.meta.v1.Time optional The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) +optional
lastTimestamp k8s.io.apimachinery.pkg.apis.meta.v1.Time optional The time at which the most recent occurrence of this event was recorded. +optional
count int32 optional The number of times this event has occurred. +optional
type string optional Type of this event (Normal, Warning), new types could be added in the future +optional
eventTime k8s.io.apimachinery.pkg.apis.meta.v1.MicroTime optional Time when this Event was first observed. +optional
series k8s.io.api.core.v1.EventSeries optional Data about the Event series this event represents or nil if it's a singleton Event. +optional
action string optional What action was taken/failed regarding to the Regarding object. +optional
related k8s.io.api.core.v1.ObjectReference optional Optional secondary object for more complex actions. +optional
reportingComponent string optional Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet. +optional
reportingInstance string optional ID of the controller instance, e.g. kubelet-xyzf. +optional

EventList

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
items []k8s.io.api.core.v1.Event repeated List of events

EventSeries

Field Type Label Description
count int32 optional Number of occurrences in this series up to the last heartbeat time
lastObservedTime k8s.io.apimachinery.pkg.apis.meta.v1.MicroTime optional Time of the last occurrence observed
state string optional State of this Series: Ongoing or Finished Deprecated. Planned removal for 1.18

EventSource

Field Type Label Description
component string optional Component from which the event is generated. +optional
host string optional Node name on which the event is generated. +optional

ExecAction

Field Type Label Description
command []string repeated 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 (’

FCVolumeSource

Field Type Label Description
targetWWNs []string repeated Optional: FC target worldwide names (WWNs) +optional
lun int32 optional Optional: FC target lun number +optional
fsType string optional 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
readOnly bool optional Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional
wwids []string repeated Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. +optional

FlexPersistentVolumeSource

Field Type Label Description
driver string optional Driver is the name of the driver to use for this volume.
fsType string optional 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
secretRef k8s.io.api.core.v1.SecretReference optional 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
readOnly bool optional Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional
options []k8s.io.api.core.v1.FlexPersistentVolumeSource.OptionsEntry repeated Optional: Extra command options if any. +optional

FlexPersistentVolumeSource.OptionsEntry

Field Type Label Description
key string optional
value string optional

FlexVolumeSource

Field Type Label Description
driver string optional Driver is the name of the driver to use for this volume.
fsType string optional 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
secretRef k8s.io.api.core.v1.LocalObjectReference optional 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
readOnly bool optional Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional
options []k8s.io.api.core.v1.FlexVolumeSource.OptionsEntry repeated Optional: Extra command options if any. +optional

FlexVolumeSource.OptionsEntry

Field Type Label Description
key string optional
value string optional

FlockerVolumeSource

Field Type Label Description
datasetName string optional Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated +optional
datasetUUID string optional UUID of the dataset. This is unique identifier of a Flocker dataset +optional

GCEPersistentDiskVolumeSource

Field Type Label Description
pdName string optional 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
fsType string optional 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
partition int32 optional 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
readOnly bool optional ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk +optional

GitRepoVolumeSource

Field Type Label Description
repository string optional Repository URL
revision string optional Commit hash for the specified revision. +optional
directory string optional 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

GlusterfsPersistentVolumeSource

Field Type Label Description
endpoints string optional EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
path string optional Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
readOnly bool optional ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod +optional
endpointsNamespace string optional 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

GlusterfsVolumeSource

Field Type Label Description
endpoints string optional EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
path string optional Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
readOnly bool optional ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod +optional

HTTPGetAction

Field Type Label Description
path string optional Path to access on the HTTP server. +optional
port k8s.io.apimachinery.pkg.util.intstr.IntOrString optional 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.
host string optional Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead. +optional
scheme string optional Scheme to use for connecting to the host. Defaults to HTTP. +optional
httpHeaders []k8s.io.api.core.v1.HTTPHeader repeated Custom headers to set in the request. HTTP allows repeated headers. +optional

HTTPHeader

Field Type Label Description
name string optional The header field name
value string optional The header field value

Handler

Field Type Label Description
exec k8s.io.api.core.v1.ExecAction optional One and only one of the following should be specified. Exec specifies the action to take. +optional
httpGet k8s.io.api.core.v1.HTTPGetAction optional HTTPGet specifies the http request to perform. +optional
tcpSocket k8s.io.api.core.v1.TCPSocketAction optional TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported TODO: implement a realistic TCP lifecycle hook +optional

HostAlias

Field Type Label Description
ip string optional IP address of the host file entry.
hostnames []string repeated Hostnames for the above IP address.

HostPathVolumeSource

Field Type Label Description
path string optional Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
type string optional Type for HostPath Volume Defaults to "” More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath +optional

ISCSIPersistentVolumeSource

Field Type Label Description
targetPortal string optional 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).
iqn string optional Target iSCSI Qualified Name.
lun int32 optional iSCSI Target Lun number.
iscsiInterface string optional iSCSI Interface Name that uses an iSCSI transport. Defaults to ‘default’ (tcp). +optional
fsType string optional 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
readOnly bool optional ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. +optional
portals []string repeated 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
chapAuthDiscovery bool optional whether support iSCSI Discovery CHAP authentication +optional
chapAuthSession bool optional whether support iSCSI Session CHAP authentication +optional
secretRef k8s.io.api.core.v1.SecretReference optional CHAP Secret for iSCSI target and initiator authentication +optional
initiatorName string optional Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. +optional

ISCSIVolumeSource

Field Type Label Description
targetPortal string optional 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).
iqn string optional Target iSCSI Qualified Name.
lun int32 optional iSCSI Target Lun number.
iscsiInterface string optional iSCSI Interface Name that uses an iSCSI transport. Defaults to ‘default’ (tcp). +optional
fsType string optional 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
readOnly bool optional ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. +optional
portals []string repeated 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
chapAuthDiscovery bool optional whether support iSCSI Discovery CHAP authentication +optional
chapAuthSession bool optional whether support iSCSI Session CHAP authentication +optional
secretRef k8s.io.api.core.v1.LocalObjectReference optional CHAP Secret for iSCSI target and initiator authentication +optional
initiatorName string optional Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. +optional

KeyToPath

Field Type Label Description
key string optional The key to project.
path string optional 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 ‘..'.
mode int32 optional Optional: mode bits to use on this file, must be a value between 0 and 0777. 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

Field Type Label Description
postStart k8s.io.api.core.v1.Handler optional PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks +optional
preStop k8s.io.api.core.v1.Handler optional PreStop is called immediately before a container is terminated due to an API request or management event such as liveness 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

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
spec k8s.io.api.core.v1.LimitRangeSpec optional Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional

LimitRangeItem

Field Type Label Description
type string optional Type of resource that this limit applies to. +optional
max []k8s.io.api.core.v1.LimitRangeItem.MaxEntry repeated Max usage constraints on this kind by resource name. +optional
min []k8s.io.api.core.v1.LimitRangeItem.MinEntry repeated Min usage constraints on this kind by resource name. +optional
default []k8s.io.api.core.v1.LimitRangeItem.DefaultEntry repeated Default resource requirement limit value by resource name if resource limit is omitted. +optional
defaultRequest []k8s.io.api.core.v1.LimitRangeItem.DefaultRequestEntry repeated DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. +optional
maxLimitRequestRatio []k8s.io.api.core.v1.LimitRangeItem.MaxLimitRequestRatioEntry repeated 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

LimitRangeItem.DefaultEntry

Field Type Label Description
key string optional
value k8s.io.apimachinery.pkg.api.resource.Quantity optional

LimitRangeItem.DefaultRequestEntry

Field Type Label Description
key string optional
value k8s.io.apimachinery.pkg.api.resource.Quantity optional

LimitRangeItem.MaxEntry

Field Type Label Description
key string optional
value k8s.io.apimachinery.pkg.api.resource.Quantity optional

LimitRangeItem.MaxLimitRequestRatioEntry

Field Type Label Description
key string optional
value k8s.io.apimachinery.pkg.api.resource.Quantity optional

LimitRangeItem.MinEntry

Field Type Label Description
key string optional
value k8s.io.apimachinery.pkg.api.resource.Quantity optional

LimitRangeList

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
items []k8s.io.api.core.v1.LimitRange repeated Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/

LimitRangeSpec

Field Type Label Description
limits []k8s.io.api.core.v1.LimitRangeItem repeated Limits is the list of LimitRangeItem objects that are enforced.

List

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
items []k8s.io.apimachinery.pkg.runtime.RawExtension repeated List of objects

LoadBalancerIngress

Field Type Label Description
ip string optional IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers) +optional
hostname string optional Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers) +optional

LoadBalancerStatus

Field Type Label Description
ingress []k8s.io.api.core.v1.LoadBalancerIngress repeated 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

Field Type Label Description
name string optional Name 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

LocalVolumeSource

Field Type Label Description
path string optional The full path to the volume on the node. It can be either a directory or block device (disk, partition, …).
fsType string optional 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

NFSVolumeSource

Field Type Label Description
server string optional Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
path string optional Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
readOnly bool optional ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs +optional

Namespace

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
spec k8s.io.api.core.v1.NamespaceSpec optional Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional
status k8s.io.api.core.v1.NamespaceStatus optional Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional

NamespaceList

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
items []k8s.io.api.core.v1.Namespace repeated Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

NamespaceSpec

Field Type Label Description
finalizers []string repeated 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

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

Node

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
spec k8s.io.api.core.v1.NodeSpec optional Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional
status k8s.io.api.core.v1.NodeStatus optional Most recently observed status of the node. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional

NodeAddress

Field Type Label Description
type string optional Node address type, one of Hostname, ExternalIP or InternalIP.
address string optional The node address.

NodeAffinity

Field Type Label Description
requiredDuringSchedulingIgnoredDuringExecution k8s.io.api.core.v1.NodeSelector optional 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
preferredDuringSchedulingIgnoredDuringExecution []k8s.io.api.core.v1.PreferredSchedulingTerm repeated 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

Field Type Label Description
type string optional Type of node condition.
status string optional Status of the condition, one of True, False, Unknown.
lastHeartbeatTime k8s.io.apimachinery.pkg.apis.meta.v1.Time optional Last time we got an update on a given condition. +optional
lastTransitionTime k8s.io.apimachinery.pkg.apis.meta.v1.Time optional Last time the condition transit from one status to another. +optional
reason string optional (brief) reason for the condition's last transition. +optional
message string optional Human readable message indicating details about last transition. +optional

NodeConfigSource

Field Type Label Description
configMap k8s.io.api.core.v1.ConfigMapNodeConfigSource optional ConfigMap is a reference to a Node's ConfigMap

NodeConfigStatus

Field Type Label Description
assigned k8s.io.api.core.v1.NodeConfigSource optional 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
active k8s.io.api.core.v1.NodeConfigSource optional 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
lastKnownGood k8s.io.api.core.v1.NodeConfigSource optional 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
error string optional 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

Field Type Label Description
kubeletEndpoint k8s.io.api.core.v1.DaemonEndpoint optional Endpoint on which Kubelet is listening. +optional

NodeList

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
items []k8s.io.api.core.v1.Node repeated List of nodes

NodeProxyOptions

Field Type Label Description
path string optional Path is the URL path to use for the current proxy request to node. +optional

NodeResources

Field Type Label Description
capacity []k8s.io.api.core.v1.NodeResources.CapacityEntry repeated Capacity represents the available resources of a node

NodeResources.CapacityEntry

Field Type Label Description
key string optional
value k8s.io.apimachinery.pkg.api.resource.Quantity optional

NodeSelector

Field Type Label Description
nodeSelectorTerms []k8s.io.api.core.v1.NodeSelectorTerm repeated Required. A list of node selector terms. The terms are ORed.

NodeSelectorRequirement

Field Type Label Description
key string optional The label key that the selector applies to.
operator string optional Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values []string repeated 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

NodeSelectorTerm

Field Type Label Description
matchExpressions []k8s.io.api.core.v1.NodeSelectorRequirement repeated A list of node selector requirements by node's labels. +optional
matchFields []k8s.io.api.core.v1.NodeSelectorRequirement repeated A list of node selector requirements by node's fields. +optional

NodeSpec

Field Type Label Description
podCIDR string optional PodCIDR represents the pod IP range assigned to the node. +optional
podCIDRs []string repeated 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
providerID string optional ID of the node assigned by the cloud provider in the format: :// +optional
unschedulable bool optional 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
taints []k8s.io.api.core.v1.Taint repeated If specified, the node's taints. +optional
configSource k8s.io.api.core.v1.NodeConfigSource optional If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field +optional
externalID string optional Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966 +optional

NodeStatus

Field Type Label Description
capacity []k8s.io.api.core.v1.NodeStatus.CapacityEntry repeated Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity +optional
allocatable []k8s.io.api.core.v1.NodeStatus.AllocatableEntry repeated Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity. +optional
phase string optional 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
conditions []k8s.io.api.core.v1.NodeCondition repeated Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition +optional +patchMergeKey=type +patchStrategy=merge
addresses []k8s.io.api.core.v1.NodeAddress repeated 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
daemonEndpoints k8s.io.api.core.v1.NodeDaemonEndpoints optional Endpoints of daemons running on the Node. +optional
nodeInfo k8s.io.api.core.v1.NodeSystemInfo optional Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info +optional
images []k8s.io.api.core.v1.ContainerImage repeated List of container images on this node +optional
volumesInUse []string repeated List of attachable volumes in use (mounted) by the node. +optional
volumesAttached []k8s.io.api.core.v1.AttachedVolume repeated List of volumes that are attached to the node. +optional
config k8s.io.api.core.v1.NodeConfigStatus optional Status of the config assigned to the node via the dynamic Kubelet config feature. +optional

NodeStatus.AllocatableEntry

Field Type Label Description
key string optional
value k8s.io.apimachinery.pkg.api.resource.Quantity optional

NodeStatus.CapacityEntry

Field Type Label Description
key string optional
value k8s.io.apimachinery.pkg.api.resource.Quantity optional

NodeSystemInfo

Field Type Label Description
machineID string optional 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
systemUUID string optional 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/getting-system-uuid.html
bootID string optional Boot ID reported by the node.
kernelVersion string optional Kernel Version reported by the node from ‘uname -r’ (e.g. 3.16.0-0.bpo.4-amd64).
osImage string optional OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).
containerRuntimeVersion string optional ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).
kubeletVersion string optional Kubelet Version reported by the node.
kubeProxyVersion string optional KubeProxy Version reported by the node.
operatingSystem string optional The Operating System reported by the node
architecture string optional The Architecture reported by the node

ObjectFieldSelector

Field Type Label Description
apiVersion string optional Version of the schema the FieldPath is written in terms of, defaults to “v1”. +optional
fieldPath string optional Path of the field to select in the specified API version.

ObjectReference

Field Type Label Description
kind string optional Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
namespace string optional Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ +optional
name string optional Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +optional
uid string optional UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids +optional
apiVersion string optional API version of the referent. +optional
resourceVersion string optional Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional
fieldPath string optional 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

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
spec k8s.io.api.core.v1.PersistentVolumeSpec optional 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
status k8s.io.api.core.v1.PersistentVolumeStatus optional 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

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
spec k8s.io.api.core.v1.PersistentVolumeClaimSpec optional 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
status k8s.io.api.core.v1.PersistentVolumeClaimStatus optional 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

Field Type Label Description
type string optional
status string optional
lastProbeTime k8s.io.apimachinery.pkg.apis.meta.v1.Time optional Last time we probed the condition. +optional
lastTransitionTime k8s.io.apimachinery.pkg.apis.meta.v1.Time optional Last time the condition transitioned from one status to another. +optional
reason string optional 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
message string optional Human-readable message indicating details about last transition. +optional

PersistentVolumeClaimList

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
items []k8s.io.api.core.v1.PersistentVolumeClaim repeated A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

PersistentVolumeClaimSpec

Field Type Label Description
accessModes []string repeated AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 +optional
selector k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector optional A label query over volumes to consider for binding. +optional
resources k8s.io.api.core.v1.ResourceRequirements optional Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources +optional
volumeName string optional VolumeName is the binding reference to the PersistentVolume backing this claim. +optional
storageClassName string optional Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 +optional
volumeMode string optional volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. +optional
dataSource k8s.io.api.core.v1.TypedLocalObjectReference optional This field requires the VolumeSnapshotDataSource alpha feature gate to be enabled and currently VolumeSnapshot is the only supported data source. If the provisioner can support VolumeSnapshot data source, it will create a new volume and data will be restored to the volume at the same time. If the provisioner does not support VolumeSnapshot data source, volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change. +optional

PersistentVolumeClaimStatus

Field Type Label Description
phase string optional Phase represents the current phase of PersistentVolumeClaim. +optional
accessModes []string repeated 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
capacity []k8s.io.api.core.v1.PersistentVolumeClaimStatus.CapacityEntry repeated Represents the actual resources of the underlying volume. +optional
conditions []k8s.io.api.core.v1.PersistentVolumeClaimCondition repeated 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

PersistentVolumeClaimStatus.CapacityEntry

Field Type Label Description
key string optional
value k8s.io.apimachinery.pkg.api.resource.Quantity optional

PersistentVolumeClaimVolumeSource

Field Type Label Description
claimName string optional 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
readOnly bool optional Will force the ReadOnly setting in VolumeMounts. Default false. +optional

PersistentVolumeList

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
items []k8s.io.api.core.v1.PersistentVolume repeated List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes

PersistentVolumeSource

Field Type Label Description
gcePersistentDisk k8s.io.api.core.v1.GCEPersistentDiskVolumeSource optional 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
awsElasticBlockStore k8s.io.api.core.v1.AWSElasticBlockStoreVolumeSource optional AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore +optional
hostPath k8s.io.api.core.v1.HostPathVolumeSource optional 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
glusterfs k8s.io.api.core.v1.GlusterfsPersistentVolumeSource optional 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
nfs k8s.io.api.core.v1.NFSVolumeSource optional NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs +optional
rbd k8s.io.api.core.v1.RBDPersistentVolumeSource optional RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md +optional
iscsi k8s.io.api.core.v1.ISCSIPersistentVolumeSource optional 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
cinder k8s.io.api.core.v1.CinderPersistentVolumeSource optional Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md +optional
cephfs k8s.io.api.core.v1.CephFSPersistentVolumeSource optional CephFS represents a Ceph FS mount on the host that shares a pod's lifetime +optional
fc k8s.io.api.core.v1.FCVolumeSource optional FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. +optional
flocker k8s.io.api.core.v1.FlockerVolumeSource optional 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
flexVolume k8s.io.api.core.v1.FlexPersistentVolumeSource optional FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. +optional
azureFile k8s.io.api.core.v1.AzureFilePersistentVolumeSource optional AzureFile represents an Azure File Service mount on the host and bind mount to the pod. +optional
vsphereVolume k8s.io.api.core.v1.VsphereVirtualDiskVolumeSource optional VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine +optional
quobyte k8s.io.api.core.v1.QuobyteVolumeSource optional Quobyte represents a Quobyte mount on the host that shares a pod's lifetime +optional
azureDisk k8s.io.api.core.v1.AzureDiskVolumeSource optional AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. +optional
photonPersistentDisk k8s.io.api.core.v1.PhotonPersistentDiskVolumeSource optional PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
portworxVolume k8s.io.api.core.v1.PortworxVolumeSource optional PortworxVolume represents a portworx volume attached and mounted on kubelets host machine +optional
scaleIO k8s.io.api.core.v1.ScaleIOPersistentVolumeSource optional ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. +optional
local k8s.io.api.core.v1.LocalVolumeSource optional Local represents directly-attached storage with node affinity +optional
storageos k8s.io.api.core.v1.StorageOSPersistentVolumeSource optional 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
csi k8s.io.api.core.v1.CSIPersistentVolumeSource optional CSI represents storage that is handled by an external CSI driver (Beta feature). +optional

PersistentVolumeSpec

Field Type Label Description
capacity []k8s.io.api.core.v1.PersistentVolumeSpec.CapacityEntry repeated A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity +optional
persistentVolumeSource k8s.io.api.core.v1.PersistentVolumeSource optional The actual volume backing the persistent volume.
accessModes []string repeated AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes +optional
claimRef k8s.io.api.core.v1.ObjectReference optional 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
persistentVolumeReclaimPolicy string optional 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
storageClassName string optional Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. +optional
mountOptions []string repeated 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
volumeMode string optional 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. This is a beta feature. +optional
nodeAffinity k8s.io.api.core.v1.VolumeNodeAffinity optional 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

PersistentVolumeSpec.CapacityEntry

Field Type Label Description
key string optional
value k8s.io.apimachinery.pkg.api.resource.Quantity optional

PersistentVolumeStatus

Field Type Label Description
phase string optional 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
message string optional A human-readable message indicating details about why the volume is in this state. +optional
reason string optional Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI. +optional

PhotonPersistentDiskVolumeSource

Field Type Label Description
pdID string optional ID that identifies Photon Controller persistent disk
fsType string optional 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

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
spec k8s.io.api.core.v1.PodSpec optional Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional
status k8s.io.api.core.v1.PodStatus optional 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/api-conventions.md#spec-and-status +optional

PodAffinity

Field Type Label Description
requiredDuringSchedulingIgnoredDuringExecution []k8s.io.api.core.v1.PodAffinityTerm repeated 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
preferredDuringSchedulingIgnoredDuringExecution []k8s.io.api.core.v1.WeightedPodAffinityTerm repeated 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

PodAffinityTerm

Field Type Label Description
labelSelector k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector optional A label query over a set of resources, in this case pods. +optional
namespaces []string repeated namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means “this pod's namespace” +optional
topologyKey string optional 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.

PodAntiAffinity

Field Type Label Description
requiredDuringSchedulingIgnoredDuringExecution []k8s.io.api.core.v1.PodAffinityTerm repeated 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
preferredDuringSchedulingIgnoredDuringExecution []k8s.io.api.core.v1.WeightedPodAffinityTerm repeated 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

Field Type Label Description
stdin bool optional Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. +optional
stdout bool optional Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. +optional
stderr bool optional Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. +optional
tty bool optional 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
container string optional The container in which to execute the command. Defaults to only container if there is only one container in the pod. +optional

PodCondition

Field Type Label Description
type string optional Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
status string optional 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
lastProbeTime k8s.io.apimachinery.pkg.apis.meta.v1.Time optional Last time we probed the condition. +optional
lastTransitionTime k8s.io.apimachinery.pkg.apis.meta.v1.Time optional Last time the condition transitioned from one status to another. +optional
reason string optional Unique, one-word, CamelCase reason for the condition's last transition. +optional
message string optional Human-readable message indicating details about last transition. +optional

PodDNSConfig

Field Type Label Description
nameservers []string repeated 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
searches []string repeated 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
options []k8s.io.api.core.v1.PodDNSConfigOption repeated 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

Field Type Label Description
name string optional Required.
value string optional +optional

PodExecOptions

Field Type Label Description
stdin bool optional Redirect the standard input stream of the pod for this call. Defaults to false. +optional
stdout bool optional Redirect the standard output stream of the pod for this call. Defaults to true. +optional
stderr bool optional Redirect the standard error stream of the pod for this call. Defaults to true. +optional
tty bool optional TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. +optional
container string optional Container in which to execute the command. Defaults to only container if there is only one container in the pod. +optional
command []string repeated Command is the remote command to execute. argv array. Not executed within a shell.

PodIP

Field Type Label Description
ip string optional ip is an IP address (IPv4 or IPv6) assigned to the pod

PodList

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
items []k8s.io.api.core.v1.Pod repeated List of pods. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md

PodLogOptions

Field Type Label Description
container string optional The container for which to stream logs. Defaults to only container if there is one container in the pod. +optional
follow bool optional Follow the log stream of the pod. Defaults to false. +optional
previous bool optional Return previous terminated container logs. Defaults to false. +optional
sinceSeconds int64 optional 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
sinceTime k8s.io.apimachinery.pkg.apis.meta.v1.Time optional 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
timestamps bool optional If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. +optional
tailLines int64 optional 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
limitBytes int64 optional 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

PodPortForwardOptions

Field Type Label Description
ports []int32 repeated List of ports to forward Required when using WebSockets +optional

PodProxyOptions

Field Type Label Description
path string optional Path is the URL path to use for the current proxy request to pod. +optional

PodReadinessGate

Field Type Label Description
conditionType string optional ConditionType refers to a condition in the pod's condition list with matching type.

PodSecurityContext

Field Type Label Description
seLinuxOptions k8s.io.api.core.v1.SELinuxOptions optional 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
windowsOptions k8s.io.api.core.v1.WindowsSecurityContextOptions optional 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
runAsUser int64 optional The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. +optional
runAsGroup int64 optional 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
runAsNonRoot bool optional Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional
supplementalGroups []int64 repeated 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
fsGroup int64 optional 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
sysctls []k8s.io.api.core.v1.Sysctl repeated Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. +optional

PodSignature

Field Type Label Description
podController k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference optional Reference to controller whose pods should avoid this node. +optional

PodSpec

Field Type Label Description
volumes []k8s.io.api.core.v1.Volume repeated 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
initContainers []k8s.io.api.core.v1.Container repeated 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, or Liveness 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
containers []k8s.io.api.core.v1.Container repeated 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
ephemeralContainers []k8s.io.api.core.v1.EphemeralContainer repeated EphemeralContainers is the list of ephemeral containers that run in this pod. Ephemeral containers are added to an existing pod as a result of a user-initiated action such as troubleshooting. This list is read-only in the pod spec. It may not be specified in a create or modified in an update of a pod or pod template. To add an ephemeral container use the pod's ephemeralcontainers subresource, which allows update using the EphemeralContainers kind. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. +optional +patchMergeKey=name +patchStrategy=merge
restartPolicy string optional 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
terminationGracePeriodSeconds int64 optional 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
activeDeadlineSeconds int64 optional 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
dnsPolicy string optional 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
nodeSelector []k8s.io.api.core.v1.PodSpec.NodeSelectorEntry repeated 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
serviceAccountName string optional 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
serviceAccount string optional DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. +k8s:conversion-gen=false +optional
automountServiceAccountToken bool optional AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. +optional
nodeName string optional 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
hostNetwork bool optional 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
hostPID bool optional Use the host's pid namespace. Optional: Default to false. +k8s:conversion-gen=false +optional
hostIPC bool optional Use the host's ipc namespace. Optional: Default to false. +k8s:conversion-gen=false +optional
shareProcessNamespace bool optional 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. This field is beta-level and may be disabled with the PodShareProcessNamespace feature. +k8s:conversion-gen=false +optional
securityContext k8s.io.api.core.v1.PodSecurityContext optional SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. +optional
imagePullSecrets []k8s.io.api.core.v1.LocalObjectReference repeated 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
hostname string optional Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. +optional
subdomain string optional If specified, the fully qualified Pod hostname will be “...svc.”. If not specified, the pod will not have a domainname at all. +optional
affinity k8s.io.api.core.v1.Affinity optional If specified, the pod's scheduling constraints +optional
schedulerName string optional If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. +optional
tolerations []k8s.io.api.core.v1.Toleration repeated If specified, the pod's tolerations. +optional
hostAliases []k8s.io.api.core.v1.HostAlias repeated 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
priorityClassName string optional 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
priority int32 optional 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
dnsConfig k8s.io.api.core.v1.PodDNSConfig optional Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. +optional
readinessGates []k8s.io.api.core.v1.PodReadinessGate repeated 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
runtimeClassName string optional 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
enableServiceLinks bool optional 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
preemptionPolicy string optional PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature. +optional
overhead []k8s.io.api.core.v1.PodSpec.OverheadEntry repeated 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
topologySpreadConstraints []k8s.io.api.core.v1.TopologySpreadConstraint repeated 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. This field is alpha-level and is only honored by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints are ANDed. +optional +patchMergeKey=topologyKey +patchStrategy=merge +listType=map +listMapKey=topologyKey +listMapKey=whenUnsatisfiable

PodSpec.NodeSelectorEntry

Field Type Label Description
key string optional
value string optional

PodSpec.OverheadEntry

Field Type Label Description
key string optional
value k8s.io.apimachinery.pkg.api.resource.Quantity optional

PodStatus

Field Type Label Description
phase string optional 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
conditions []k8s.io.api.core.v1.PodCondition repeated Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions +optional +patchMergeKey=type +patchStrategy=merge
message string optional A human readable message indicating details about why the pod is in this condition. +optional
reason string optional A brief CamelCase message indicating details about why the pod is in this state. e.g. ‘Evicted’ +optional
nominatedNodeName string optional 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
hostIP string optional IP address of the host to which the pod is assigned. Empty if not yet scheduled. +optional
podIP string optional IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated. +optional
podIPs []k8s.io.api.core.v1.PodIP repeated 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
startTime k8s.io.apimachinery.pkg.apis.meta.v1.Time optional 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
initContainerStatuses []k8s.io.api.core.v1.ContainerStatus repeated 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
containerStatuses []k8s.io.api.core.v1.ContainerStatus repeated 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
qosClass string optional 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
ephemeralContainerStatuses []k8s.io.api.core.v1.ContainerStatus repeated Status for any ephemeral containers that running in this pod. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. +optional

PodStatusResult

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
status k8s.io.api.core.v1.PodStatus optional 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/api-conventions.md#spec-and-status +optional

PodTemplate

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
template k8s.io.api.core.v1.PodTemplateSpec optional Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional

PodTemplateList

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
items []k8s.io.api.core.v1.PodTemplate repeated List of pod templates

PodTemplateSpec

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
spec k8s.io.api.core.v1.PodSpec optional Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional

PortworxVolumeSource

Field Type Label Description
volumeID string optional VolumeID uniquely identifies a Portworx volume
fsType string optional 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.
readOnly bool optional Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional

Preconditions

Field Type Label Description
uid string optional Specifies the target UID. +optional

PreferAvoidPodsEntry

Field Type Label Description
podSignature k8s.io.api.core.v1.PodSignature optional The class of pods.
evictionTime k8s.io.apimachinery.pkg.apis.meta.v1.Time optional Time at which this entry was added to the list. +optional
reason string optional (brief) reason why this entry was added to the list. +optional
message string optional Human readable message indicating why this entry was added to the list. +optional

PreferredSchedulingTerm

Field Type Label Description
weight int32 optional Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
preference k8s.io.api.core.v1.NodeSelectorTerm optional A node selector term, associated with the corresponding weight.

Probe

Field Type Label Description
handler k8s.io.api.core.v1.Handler optional The action taken to determine the health of a container
initialDelaySeconds int32 optional Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional
timeoutSeconds int32 optional Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional
periodSeconds int32 optional How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional
successThreshold int32 optional Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. +optional
failureThreshold int32 optional Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional

ProjectedVolumeSource

Field Type Label Description
sources []k8s.io.api.core.v1.VolumeProjection repeated list of volume projections
defaultMode int32 optional Mode bits to use on created files by default. Must be a value between 0 and 0777. 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

QuobyteVolumeSource

Field Type Label Description
registry string optional 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
volume string optional Volume is a string that references an already created Quobyte volume by name.
readOnly bool optional ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. +optional
user string optional User to map volume access to Defaults to serivceaccount user +optional
group string optional Group to map volume access to Default is no group +optional
tenant string optional Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin +optional

RBDPersistentVolumeSource

Field Type Label Description
monitors []string repeated A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
image string optional The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
fsType string optional 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
pool string optional The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional
user string optional The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional
keyring string optional Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional
secretRef k8s.io.api.core.v1.SecretReference optional SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional
readOnly bool optional ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional

RBDVolumeSource

Field Type Label Description
monitors []string repeated A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
image string optional The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
fsType string optional 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
pool string optional The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional
user string optional The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional
keyring string optional Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional
secretRef k8s.io.api.core.v1.LocalObjectReference optional SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional
readOnly bool optional ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it +optional

RangeAllocation

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
range string optional Range is string that identifies the range represented by ‘data’.
data bytes optional Data is a bit array containing all allocated addresses in the previous segment.

ReplicationController

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional 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/api-conventions.md#metadata +optional
spec k8s.io.api.core.v1.ReplicationControllerSpec optional Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional
status k8s.io.api.core.v1.ReplicationControllerStatus optional 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/api-conventions.md#spec-and-status +optional

ReplicationControllerCondition

Field Type Label Description
type string optional Type of replication controller condition.
status string optional Status of the condition, one of True, False, Unknown.
lastTransitionTime k8s.io.apimachinery.pkg.apis.meta.v1.Time optional The last time the condition transitioned from one status to another. +optional
reason string optional The reason for the condition's last transition. +optional
message string optional A human readable message indicating details about the transition. +optional

ReplicationControllerList

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
items []k8s.io.api.core.v1.ReplicationController repeated List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller

ReplicationControllerSpec

Field Type Label Description
replicas int32 optional 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
minReadySeconds int32 optional 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
selector []k8s.io.api.core.v1.ReplicationControllerSpec.SelectorEntry repeated 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
template k8s.io.api.core.v1.PodTemplateSpec optional 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

ReplicationControllerSpec.SelectorEntry

Field Type Label Description
key string optional
value string optional

ReplicationControllerStatus

Field Type Label Description
replicas int32 optional Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller
fullyLabeledReplicas int32 optional The number of pods that have labels matching the labels of the pod template of the replication controller. +optional
readyReplicas int32 optional The number of ready replicas for this replication controller. +optional
availableReplicas int32 optional The number of available replicas (ready for at least minReadySeconds) for this replication controller. +optional
observedGeneration int64 optional ObservedGeneration reflects the generation of the most recently observed replication controller. +optional
conditions []k8s.io.api.core.v1.ReplicationControllerCondition repeated Represents the latest available observations of a replication controller's current state. +optional +patchMergeKey=type +patchStrategy=merge

ResourceFieldSelector

Field Type Label Description
containerName string optional Container name: required for volumes, optional for env vars +optional
resource string optional Required: resource to select
divisor k8s.io.apimachinery.pkg.api.resource.Quantity optional Specifies the output format of the exposed resources, defaults to “1” +optional

ResourceQuota

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
spec k8s.io.api.core.v1.ResourceQuotaSpec optional Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional
status k8s.io.api.core.v1.ResourceQuotaStatus optional Status defines the actual enforced quota and its current usage. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional

ResourceQuotaList

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
items []k8s.io.api.core.v1.ResourceQuota repeated Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/

ResourceQuotaSpec

Field Type Label Description
hard []k8s.io.api.core.v1.ResourceQuotaSpec.HardEntry repeated hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ +optional
scopes []string repeated A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. +optional
scopeSelector k8s.io.api.core.v1.ScopeSelector optional 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

ResourceQuotaSpec.HardEntry

Field Type Label Description
key string optional
value k8s.io.apimachinery.pkg.api.resource.Quantity optional

ResourceQuotaStatus

Field Type Label Description
hard []k8s.io.api.core.v1.ResourceQuotaStatus.HardEntry repeated Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ +optional
used []k8s.io.api.core.v1.ResourceQuotaStatus.UsedEntry repeated Used is the current observed total usage of the resource in the namespace. +optional

ResourceQuotaStatus.HardEntry

Field Type Label Description
key string optional
value k8s.io.apimachinery.pkg.api.resource.Quantity optional

ResourceQuotaStatus.UsedEntry

Field Type Label Description
key string optional
value k8s.io.apimachinery.pkg.api.resource.Quantity optional

ResourceRequirements

Field Type Label Description
limits []k8s.io.api.core.v1.ResourceRequirements.LimitsEntry repeated Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional
requests []k8s.io.api.core.v1.ResourceRequirements.RequestsEntry repeated Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ +optional

ResourceRequirements.LimitsEntry

Field Type Label Description
key string optional
value k8s.io.apimachinery.pkg.api.resource.Quantity optional

ResourceRequirements.RequestsEntry

Field Type Label Description
key string optional
value k8s.io.apimachinery.pkg.api.resource.Quantity optional

SELinuxOptions

Field Type Label Description
user string optional User is a SELinux user label that applies to the container. +optional
role string optional Role is a SELinux role label that applies to the container. +optional
type string optional Type is a SELinux type label that applies to the container. +optional
level string optional Level is SELinux level label that applies to the container. +optional

ScaleIOPersistentVolumeSource

Field Type Label Description
gateway string optional The host address of the ScaleIO API Gateway.
system string optional The name of the storage system as configured in ScaleIO.
secretRef k8s.io.api.core.v1.SecretReference optional SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
sslEnabled bool optional Flag to enable/disable SSL communication with Gateway, default false +optional
protectionDomain string optional The name of the ScaleIO Protection Domain for the configured storage. +optional
storagePool string optional The ScaleIO Storage Pool associated with the protection domain. +optional
storageMode string optional Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. +optional
volumeName string optional The name of a volume already created in the ScaleIO system that is associated with this volume source.
fsType string optional Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Default is “xfs” +optional
readOnly bool optional Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional

ScaleIOVolumeSource

Field Type Label Description
gateway string optional The host address of the ScaleIO API Gateway.
system string optional The name of the storage system as configured in ScaleIO.
secretRef k8s.io.api.core.v1.LocalObjectReference optional SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
sslEnabled bool optional Flag to enable/disable SSL communication with Gateway, default false +optional
protectionDomain string optional The name of the ScaleIO Protection Domain for the configured storage. +optional
storagePool string optional The ScaleIO Storage Pool associated with the protection domain. +optional
storageMode string optional Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. +optional
volumeName string optional The name of a volume already created in the ScaleIO system that is associated with this volume source.
fsType string optional Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. “ext4”, “xfs”, “ntfs”. Default is “xfs”. +optional
readOnly bool optional Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional

ScopeSelector

Field Type Label Description
matchExpressions []k8s.io.api.core.v1.ScopedResourceSelectorRequirement repeated A list of scope selector requirements by scope of the resources. +optional

ScopedResourceSelectorRequirement

Field Type Label Description
scopeName string optional The name of the scope that the selector applies to.
operator string optional Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
values []string repeated 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

Secret

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
data []k8s.io.api.core.v1.Secret.DataEntry repeated 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
stringData []k8s.io.api.core.v1.Secret.StringDataEntry repeated 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
type string optional Used to facilitate programmatic handling of secret data. +optional

Secret.DataEntry

Field Type Label Description
key string optional
value bytes optional

Secret.StringDataEntry

Field Type Label Description
key string optional
value string optional

SecretEnvSource

Field Type Label Description
localObjectReference k8s.io.api.core.v1.LocalObjectReference optional The Secret to select from.
optional bool optional Specify whether the Secret must be defined +optional

SecretKeySelector

Field Type Label Description
localObjectReference k8s.io.api.core.v1.LocalObjectReference optional The name of the secret in the pod's namespace to select from.
key string optional The key of the secret to select from. Must be a valid secret key.
optional bool optional Specify whether the Secret or its key must be defined +optional

SecretList

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
items []k8s.io.api.core.v1.Secret repeated Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret

SecretProjection

Field Type Label Description
localObjectReference k8s.io.api.core.v1.LocalObjectReference optional
items []k8s.io.api.core.v1.KeyToPath repeated 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 Specify whether the Secret or its key must be defined +optional

SecretReference

Field Type Label Description
name string optional Name is unique within a namespace to reference a secret resource. +optional
namespace string optional Namespace defines the space within which the secret name must be unique. +optional

SecretVolumeSource

Field Type Label Description
secretName string optional Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret +optional
items []k8s.io.api.core.v1.KeyToPath repeated 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
defaultMode int32 optional Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. 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 Specify whether the Secret or its keys must be defined +optional

SecurityContext

Field Type Label Description
capabilities k8s.io.api.core.v1.Capabilities optional The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. +optional
privileged bool optional Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. +optional
seLinuxOptions k8s.io.api.core.v1.SELinuxOptions optional The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional
windowsOptions k8s.io.api.core.v1.WindowsSecurityContextOptions optional The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional
runAsUser int64 optional The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional
runAsGroup int64 optional The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional
runAsNonRoot bool optional Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. +optional
readOnlyRootFilesystem bool optional Whether this container has a read-only root filesystem. Default is false. +optional
allowPrivilegeEscalation bool optional AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN +optional
procMount string optional procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. +optional

SerializedReference

Field Type Label Description
reference k8s.io.api.core.v1.ObjectReference optional The reference to an object in the system. +optional

Service

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
spec k8s.io.api.core.v1.ServiceSpec optional Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional
status k8s.io.api.core.v1.ServiceStatus optional Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status +optional

ServiceAccount

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta optional Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata +optional
secrets []k8s.io.api.core.v1.ObjectReference repeated 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
imagePullSecrets []k8s.io.api.core.v1.LocalObjectReference repeated 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
automountServiceAccountToken bool optional 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

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
items []k8s.io.api.core.v1.ServiceAccount repeated List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

ServiceAccountTokenProjection

Field Type Label Description
audience string optional Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. +optional
expirationSeconds int64 optional ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. +optional
path string optional Path is the path relative to the mount point of the file to project the token into.

ServiceList

Field Type Label Description
metadata k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta optional Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds +optional
items []k8s.io.api.core.v1.Service repeated List of services

ServicePort

Field Type Label Description
name string optional 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
protocol string optional The IP protocol for this port. Supports “TCP”, “UDP”, and “SCTP”. Default is TCP. +optional
port int32 optional The port that will be exposed by this service.
targetPort k8s.io.apimachinery.pkg.util.intstr.IntOrString optional 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
nodePort int32 optional The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport +optional

ServiceProxyOptions

Field Type Label Description
path string optional 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

Field Type Label Description
ports []k8s.io.api.core.v1.ServicePort repeated 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
selector []k8s.io.api.core.v1.ServiceSpec.SelectorEntry repeated 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
clusterIP string optional clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are “None”, empty string (""), or a valid IP address. “None” can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies +optional
type string optional type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. “ExternalName” maps to the specified externalName. “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. If clusterIP is “None”, no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. “NodePort” builds on ClusterIP and allocates a port on every node which routes to the clusterIP. “LoadBalancer” builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types +optional
externalIPs []string repeated 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
sessionAffinity string optional 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
loadBalancerIP string optional 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
loadBalancerSourceRanges []string repeated 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
externalName string optional externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be ExternalName. +optional
externalTrafficPolicy string optional 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
healthCheckNodePort int32 optional healthCheckNodePort specifies the healthcheck nodePort for the service. If not specified, HealthCheckNodePort is created by the service api backend with the allocated nodePort. Will use user-specified nodePort value if specified by the client. Only effects when Type is set to LoadBalancer and ExternalTrafficPolicy is set to Local. +optional
publishNotReadyAddresses bool optional publishNotReadyAddresses, when set to true, indicates that DNS implementations must publish the notReadyAddresses of subsets for the Endpoints associated with the Service. The default value is false. The primary use case for setting this field is to use a StatefulSet's Headless Service to propagate SRV records for its Pods without respect to their readiness for purpose of peer discovery. +optional
sessionAffinityConfig k8s.io.api.core.v1.SessionAffinityConfig optional sessionAffinityConfig contains the configurations of session affinity. +optional
ipFamily string optional ipFamily specifies whether this Service has a preference for a particular IP family (e.g. IPv4 vs. IPv6). If a specific IP family is requested, the clusterIP field will be allocated from that family, if it is available in the cluster. If no IP family is requested, the cluster's primary IP family will be used. Other IP fields (loadBalancerIP, loadBalancerSourceRanges, externalIPs) and controllers which allocate external load-balancers should use the same IP family. Endpoints for this Service will be of this family. This field is immutable after creation. Assigning a ServiceIPFamily not available in the cluster (e.g. IPv6 in IPv4 only cluster) is an error condition and will fail during clusterIP assignment. +optional

ServiceSpec.SelectorEntry

Field Type Label Description
key string optional
value string optional

ServiceStatus

Field Type Label Description
loadBalancer k8s.io.api.core.v1.LoadBalancerStatus optional LoadBalancer contains the current status of the load-balancer, if one is present. +optional

SessionAffinityConfig

Field Type Label Description
clientIP k8s.io.api.core.v1.ClientIPConfig optional clientIP contains the configurations of Client IP based session affinity. +optional

StorageOSPersistentVolumeSource

Field Type Label Description
volumeName string optional VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
volumeNamespace string optional VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to “default” if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. +optional
fsType string optional 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
readOnly bool optional Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional
secretRef k8s.io.api.core.v1.ObjectReference optional SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. +optional

StorageOSVolumeSource

Field Type Label Description
volumeName string optional VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
volumeNamespace string optional VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to “default” if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. +optional
fsType string optional 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
readOnly bool optional Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. +optional
secretRef k8s.io.api.core.v1.LocalObjectReference optional SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. +optional

Sysctl

Field Type Label Description
name string optional Name of a property to set
value string optional Value of a property to set

TCPSocketAction

Field Type Label Description
port k8s.io.apimachinery.pkg.util.intstr.IntOrString optional 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.
host string optional Optional: Host name to connect to, defaults to the pod IP. +optional

Taint

Field Type Label Description
key string optional Required. The taint key to be applied to a node.
value string optional Required. The taint value corresponding to the taint key. +optional
effect string optional Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
timeAdded k8s.io.apimachinery.pkg.apis.meta.v1.Time optional TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. +optional

Toleration

Field Type Label Description
key string optional 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
operator string optional 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
value string optional 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
effect string optional Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. +optional
tolerationSeconds int64 optional 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

TopologySelectorLabelRequirement

Field Type Label Description
key string optional The label key that the selector applies to.
values []string repeated An array of string values. One value must match the label to be selected. Each entry in Values is ORed.

TopologySelectorTerm

Field Type Label Description
matchLabelExpressions []k8s.io.api.core.v1.TopologySelectorLabelRequirement repeated A list of topology selector requirements by labels. +optional

TopologySpreadConstraint

Field Type Label Description
maxSkew int32 optional MaxSkew describes the degree to which pods may be unevenly distributed. It's the maximum permitted difference between the number of matching pods in any two topology domains of a given topology type. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: +——-+——-+——-+
topologyKey string optional 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.
whenUnsatisfiable string optional 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 still schedule it It's considered as “Unsatisfiable” if and only if placing incoming pod on any topology violates “MaxSkew”. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: +——-+——-+——-+
labelSelector k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector optional 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

Field Type Label Description
apiGroup string optional APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. +optional
kind string optional Kind is the type of resource being referenced
name string optional Name is the name of resource being referenced

Volume

Field Type Label Description
name string optional 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
volumeSource k8s.io.api.core.v1.VolumeSource optional 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

Field Type Label Description
name string optional name must match the name of a persistentVolumeClaim in the pod
devicePath string optional devicePath is the path inside of the container that the device will be mapped to.

VolumeMount

Field Type Label Description
name string optional This must match the Name of a Volume.
readOnly bool optional Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. +optional
mountPath string optional Path within the container at which the volume should be mounted. Must not contain ‘:'.
subPath string optional Path within the volume from which the container's volume should be mounted. Defaults to "” (volume's root). +optional
mountPropagation string optional mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. +optional
subPathExpr string optional Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "” (volume's root). SubPathExpr and SubPath are mutually exclusive. This field is beta in 1.15. +optional

VolumeNodeAffinity

Field Type Label Description
required k8s.io.api.core.v1.NodeSelector optional Required specifies hard node constraints that must be met.

VolumeProjection

Field Type Label Description
secret k8s.io.api.core.v1.SecretProjection optional information about the secret data to project +optional
downwardAPI k8s.io.api.core.v1.DownwardAPIProjection optional information about the downwardAPI data to project +optional
configMap k8s.io.api.core.v1.ConfigMapProjection optional information about the configMap data to project +optional
serviceAccountToken k8s.io.api.core.v1.ServiceAccountTokenProjection optional information about the serviceAccountToken data to project +optional

VolumeSource

Field Type Label Description
hostPath k8s.io.api.core.v1.HostPathVolumeSource optional HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath — TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write. +optional
emptyDir k8s.io.api.core.v1.EmptyDirVolumeSource optional EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir +optional
gcePersistentDisk k8s.io.api.core.v1.GCEPersistentDiskVolumeSource optional 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
awsElasticBlockStore k8s.io.api.core.v1.AWSElasticBlockStoreVolumeSource optional AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore +optional
gitRepo k8s.io.api.core.v1.GitRepoVolumeSource optional 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
secret k8s.io.api.core.v1.SecretVolumeSource optional Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret +optional
nfs k8s.io.api.core.v1.NFSVolumeSource optional NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs +optional
iscsi k8s.io.api.core.v1.ISCSIVolumeSource optional ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md +optional
glusterfs k8s.io.api.core.v1.GlusterfsVolumeSource optional Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md +optional
persistentVolumeClaim k8s.io.api.core.v1.PersistentVolumeClaimVolumeSource optional PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims +optional
rbd k8s.io.api.core.v1.RBDVolumeSource optional RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md +optional
flexVolume k8s.io.api.core.v1.FlexVolumeSource optional FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. +optional
cinder k8s.io.api.core.v1.CinderVolumeSource optional Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md +optional
cephfs k8s.io.api.core.v1.CephFSVolumeSource optional CephFS represents a Ceph FS mount on the host that shares a pod's lifetime +optional
flocker k8s.io.api.core.v1.FlockerVolumeSource optional Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running +optional
downwardAPI k8s.io.api.core.v1.DownwardAPIVolumeSource optional DownwardAPI represents downward API about the pod that should populate this volume +optional
fc k8s.io.api.core.v1.FCVolumeSource optional FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. +optional
azureFile k8s.io.api.core.v1.AzureFileVolumeSource optional AzureFile represents an Azure File Service mount on the host and bind mount to the pod. +optional
configMap k8s.io.api.core.v1.ConfigMapVolumeSource optional ConfigMap represents a configMap that should populate this volume +optional
vsphereVolume k8s.io.api.core.v1.VsphereVirtualDiskVolumeSource optional VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine +optional
quobyte k8s.io.api.core.v1.QuobyteVolumeSource optional Quobyte represents a Quobyte mount on the host that shares a pod's lifetime +optional
azureDisk k8s.io.api.core.v1.AzureDiskVolumeSource optional AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. +optional
photonPersistentDisk k8s.io.api.core.v1.PhotonPersistentDiskVolumeSource optional PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
projected k8s.io.api.core.v1.ProjectedVolumeSource optional Items for all in one resources secrets, configmaps, and downward API
portworxVolume k8s.io.api.core.v1.PortworxVolumeSource optional PortworxVolume represents a portworx volume attached and mounted on kubelets host machine +optional
scaleIO k8s.io.api.core.v1.ScaleIOVolumeSource optional ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. +optional
storageos k8s.io.api.core.v1.StorageOSVolumeSource optional StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. +optional
csi k8s.io.api.core.v1.CSIVolumeSource optional CSI (Container Storage Interface) represents storage that is handled by an external CSI driver (Alpha feature). +optional

VsphereVirtualDiskVolumeSource

Field Type Label Description
volumePath string optional Path that identifies vSphere volume vmdk
fsType string optional 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
storagePolicyName string optional Storage Policy Based Management (SPBM) profile name. +optional
storagePolicyID string optional Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. +optional

WeightedPodAffinityTerm

Field Type Label Description
weight int32 optional weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
podAffinityTerm k8s.io.api.core.v1.PodAffinityTerm optional Required. A pod affinity term, associated with the corresponding weight.

WindowsSecurityContextOptions

Field Type Label Description
gmsaCredentialSpecName string optional GMSACredentialSpecName is the name of the GMSA credential spec to use. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag. +optional
gmsaCredentialSpec string optional GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. This field is alpha-level and is only honored by servers that enable the WindowsGMSA feature flag. +optional
runAsUserName string optional The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. This field is alpha-level and it is only honored by servers that enable the WindowsRunAsUserName feature flag. +optional