华为云计算 云知识 替换DeploymentreplaceAppsV1NamespacedDeployment
替换DeploymentreplaceAppsV1NamespacedDeployment

 

功能介绍

替换Deployment。

其中以下字段支持更新:

  • metadata.labels

  • metadata.generateName

  • metadata.annotations

  • spec.template

  • spec.replicas

  • spec.revisionHistoryLimit

  • spec.progressDeadlineSeconds

调用方法

请参见如何调用API

URI

PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}

表1 路径参数

参数

是否必选

参数类型

描述

name

String

name of the Deployment

namespace

String

object name and auth scope, such as for teams and projects

表2 Query参数

参数

是否必选

参数类型

描述

dryRun

String

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

String

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

pretty

String

If 'true', then the output is pretty printed.

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

消息体的类型(格式),默认取值为“application/json”

缺省值:application/json

表4 请求Body参数

参数

是否必选

参数类型

描述

apiVersion

String

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

String

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

Standard object metadata.

spec

io.k8s.api.apps.v1.DeploymentSpec object

Specification of the desired behavior of the Deployment.

status

io.k8s.api.apps.v1.DeploymentStatus object

Most recently observed status of the Deployment.

表5 io.k8s.api.apps.v1.DeploymentSpec

参数

是否必选

参数类型

描述

minReadySeconds

Integer

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)

paused

Boolean

Indicates that the deployment is paused.

progressDeadlineSeconds

Integer

The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.

replicas

Integer

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

revisionHistoryLimit

Integer

The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.

selector

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.

strategy

io.k8s.api.apps.v1.DeploymentStrategy object

The deployment strategy to use to replace existing pods with new ones.

template

io.k8s.api.core.v1.PodTemplateSpec object

Template describes the pods that will be created.

表6 io.k8s.api.apps.v1.DeploymentStrategy

参数

是否必选

参数类型

描述

rollingUpdate

io.k8s.api.apps.v1.RollingUpdateDeployment object

Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.

type

String

Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

表7 io.k8s.api.apps.v1.RollingUpdateDeployment

参数

是否必选

参数类型

描述

maxSurge

String

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.

maxUnavailable

String

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

表8 io.k8s.api.core.v1.PodTemplateSpec

参数

是否必选

参数类型

描述

metadata

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

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

spec

io.k8s.api.core.v1.PodSpec object

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

表9 io.k8s.api.core.v1.PodSpec

参数

是否必选

参数类型

activeDeadlineSeconds

Long

affinity

io.k8s.api.core.v1.Affinity object

automountServiceAccountToken

Boolean

containers

Array of io.k8s.api.core.v1.Container objects

dnsConfig

io.k8s.api.core.v1.PodDNSConfig object

dnsPolicy

String

enableServiceLinks

Boolean

ephemeralContainers

Array of io.k8s.api.core.v1.EphemeralContainer objects

hostAliases

Array of io.k8s.api.core.v1.HostAlias objects

hostIPC

Boolean

hostNetwork

Boolean

hostPID

Boolean

hostname

String

imagePullSecrets

Array of io.k8s.api.core.v1.LocalObjectReference objects

initContainers

Array of io.k8s.api.core.v1.Container objects

nodeName

String

nodeSelector

Map<String,String>

overhead

Map<String,String>

preemptionPolicy

String

priority

Integer

priorityClassName

String

readinessGates

Array of io.k8s.api.core.v1.PodReadinessGate objects

restartPolicy

String

runtimeClassName

String

schedulerName

String

securityContext

io.k8s.api.core.v1.PodSecurityContext object

serviceAccount

String

serviceAccountName

String

setHostnameAsFQDN

Boolean

shareProcessNamespace

Boolean

subdomain

String

terminationGracePeriodSeconds

Long

tolerations

Array of io.k8s.api.core.v1.Toleration objects

topologySpreadConstraints

Array of io.k8s.api.core.v1.TopologySpreadConstraint objects

volumes

Array of io.k8s.api.core.v1.Volume objects

表10 io.k8s.api.core.v1.Affinity

参数

是否必选

参数类型

描述

nodeAffinity

io.k8s.api.core.v1.NodeAffinity object

Describes node affinity scheduling rules for the pod.

podAffinity

io.k8s.api.core.v1.PodAffinity object

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

podAntiAffinity

io.k8s.api.core.v1.PodAntiAffinity object

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

表11 io.k8s.api.core.v1.NodeAffinity

参数

是否必选

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of io.k8s.api.core.v1.PreferredSchedulingTerm objects

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.

requiredDuringSchedulingIgnoredDuringExecution

io.k8s.api.core.v1.NodeSelector object

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.

表12 io.k8s.api.core.v1.PreferredSchedulingTerm

参数

是否必选

参数类型

描述

preference

io.k8s.api.core.v1.NodeSelectorTerm object

A node selector term, associated with the corresponding weight.

weight

Integer

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

表13 io.k8s.api.core.v1.NodeSelectorTerm

参数

是否必选

参数类型

描述

matchExpressions

Array of io.k8s.api.core.v1.NodeSelectorRequirement objects

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

matchFields

Array of io.k8s.api.core.v1.NodeSelectorRequirement objects

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

表14 io.k8s.api.core.v1.NodeSelector

参数

是否必选

参数类型

描述

nodeSelectorTerms

Array of io.k8s.api.core.v1.NodeSelectorTerm objects

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

表15 io.k8s.api.core.v1.NodeSelectorRequirement

参数

是否必选

参数类型

描述

key

String

The label key that the selector applies to.

operator

String

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

values

Array of strings

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 int erp reted as an integer. This array is replaced during a strategic merge patch.

表16 io.k8s.api.core.v1.PodAffinity

参数

是否必选

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of io.k8s.api.core.v1.WeightedPodAffinityTerm objects

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.

requiredDuringSchedulingIgnoredDuringExecution

Array of io.k8s.api.core.v1.PodAffinityTerm objects

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.

表17 io.k8s.api.core.v1.PodAntiAffinity

参数

是否必选

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of io.k8s.api.core.v1.WeightedPodAffinityTerm objects

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.

requiredDuringSchedulingIgnoredDuringExecution

Array of io.k8s.api.core.v1.PodAffinityTerm objects

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.

表18 io.k8s.api.core.v1.WeightedPodAffinityTerm

参数

是否必选

参数类型

描述

podAffinityTerm

io.k8s.api.core.v1.PodAffinityTerm object

Required. A pod affinity term, associated with the corresponding weight.

weight

Integer

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

表19 io.k8s.api.core.v1.PodAffinityTerm

参数

是否必选

参数类型

描述

labelSelector

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

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

namespaces

Array of strings

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

topologyKey

String

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.

表20 io.k8s.api.core.v1.PodDNSConfig

参数

是否必选

参数类型

描述

nameservers

Array of strings

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

options

Array of io.k8s.api.core.v1.PodDNSConfigOption objects

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.

searches

Array of strings

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.

表21 io.k8s.api.core.v1.PodDNSConfigOption

参数

是否必选

参数类型

描述

name

String

Required.

value

String

value is the value of the option

表22 io.k8s.api.core.v1.EphemeralContainer

参数

是否必选

参数类型

描述

args

Array of strings

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

command

Array of strings

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

env

Array of io.k8s.api.core.v1.EnvVar objects

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

envFrom

Array of io.k8s.api.core.v1.EnvFromSource objects

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.

image

String

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

imagePullPolicy

String

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

lifecycle

io.k8s.api.core.v1.Lifecycle object

Lifecycle is not allowed for ephemeral containers.

livenessProbe

io.k8s.api.core.v1.Probe object

Probes are not allowed for ephemeral containers.

name

String

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

ports

Array of io.k8s.api.core.v1.ContainerPort objects

Ports are not allowed for ephemeral containers.

readinessProbe

io.k8s.api.core.v1.Probe object

Probes are not allowed for ephemeral containers.

resources

io.k8s.api.core.v1.ResourceRequirements object

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

securityContext

io.k8s.api.core.v1.SecurityContext object

SecurityContext is not allowed for ephemeral containers.

startupProbe

io.k8s.api.core.v1.Probe object

Probes are not allowed for ephemeral containers.

stdin

Boolean

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.

stdinOnce

Boolean

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

targetContainerName

String

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.

terminationMessagePath

String

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.

terminationMessagePolicy

String

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.

tty

Boolean

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

volumeDevices

Array of io.k8s.api.core.v1.VolumeDevice objects

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

volumeMounts

Array of io.k8s.api.core.v1.VolumeMount objects

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

workingDir

String

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.

表23 io.k8s.api.core.v1.HostAlias

参数

是否必选

参数类型

描述

hostnames

Array of strings

Hostnames for the above IP address.

ip

String

IP address of the host file entry.

表24 io.k8s.api.core.v1.LocalObjectReference

参数

是否必选

参数类型

描述

name

String

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

表25 io.k8s.api.core.v1.Container

参数

是否必选

参数类型

描述

args

Array of strings

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

command

Array of strings

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

env

Array of io.k8s.api.core.v1.EnvVar objects

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

envFrom

Array of io.k8s.api.core.v1.EnvFromSource objects

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.

image

String

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.

imagePullPolicy

String

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

lifecycle

io.k8s.api.core.v1.Lifecycle object

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

livenessProbe

io.k8s.api.core.v1.Probe object

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

name

String

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

ports

Array of io.k8s.api.core.v1.ContainerPort objects

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.

readinessProbe

io.k8s.api.core.v1.Probe object

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

resources

io.k8s.api.core.v1.ResourceRequirements object

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

securityContext

io.k8s.api.core.v1.SecurityContext object

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/

startupProbe

io.k8s.api.core.v1.Probe object

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

stdin

Boolean

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.

stdinOnce

Boolean

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

terminationMessagePath

String

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.

terminationMessagePolicy

String

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.

tty

Boolean

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

volumeDevices

Array of io.k8s.api.core.v1.VolumeDevice objects

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

volumeMounts

Array of io.k8s.api.core.v1.VolumeMount objects

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

workingDir

String

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.

表26 io.k8s.api.core.v1.EnvVar

参数

是否必选

参数类型

描述

name

String

Name of the environment variable. Must be a C_IDENTIFIER.

value

String

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

valueFrom

io.k8s.api.core.v1.EnvVarSource object

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

表27 io.k8s.api.core.v1.EnvVarSource

参数

是否必选

参数类型

描述

configMapKeyRef

io.k8s.api.core.v1.ConfigMapKeySelector object

Selects a key of a ConfigMap.

fieldRef

io.k8s.api.core.v1.ObjectFieldSelector object

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

resourceFieldRef

io.k8s.api.core.v1.ResourceFieldSelector object

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.

secretKeyRef

io.k8s.api.core.v1.SecretKeySelector object

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

表28 io.k8s.api.core.v1.ConfigMapKeySelector

参数

是否必选

参数类型

描述

key

String

The key to select.

name

String

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

optional

Boolean

Specify whether the ConfigMap or its key must be defined

表29 io.k8s.api.core.v1.SecretKeySelector

参数

是否必选

参数类型

描述

key

String

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

name

String

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

optional

Boolean

Specify whether the Secret or its key must be defined

表30 io.k8s.api.core.v1.EnvFromSource

参数

是否必选

参数类型

描述

configMapRef

io.k8s.api.core.v1.ConfigMapEnvSource object

The ConfigMap to select from

prefix

String

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

secretRef

io.k8s.api.core.v1.SecretEnvSource object

The Secret to select from

表31 io.k8s.api.core.v1.ConfigMapEnvSource

参数

是否必选

参数类型

描述

name

String

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

optional

Boolean

Specify whether the ConfigMap must be defined

表32 io.k8s.api.core.v1.SecretEnvSource

参数

是否必选

参数类型

描述

name

String

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

optional

Boolean

Specify whether the Secret must be defined

表33 io.k8s.api.core.v1.Lifecycle

参数

是否必选

参数类型

描述

postStart

io.k8s.api.core.v1.Handler object

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

preStop

io.k8s.api.core.v1.Handler object

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

表34 io.k8s.api.core.v1.Handler

参数

是否必选

参数类型

描述

exec

io.k8s.api.core.v1.ExecAction object

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

httpGet

io.k8s.api.core.v1.HTTPGetAction object

HTTPGet specifies the http request to perform.

tcpSocket

io.k8s.api.core.v1.TCPSocketAction object

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

表35 io.k8s.api.core.v1.ContainerPort

参数

是否必选

参数类型

描述

containerPort

Integer

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

hostIP

String

What host IP to bind the external port to.

hostPort

Integer

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.

name

String

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.

protocol

String

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

表36 io.k8s.api.core.v1.SecurityContext

参数

是否必选

参数类型

描述

allowPrivilegeEscalation

Boolean

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

capabilities

io.k8s.api.core.v1.Capabilities object

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

privileged

Boolean

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

procMount

String

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.

readOnlyRootFilesystem

Boolean

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

runAsGroup

Long

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.

runAsNonRoot

Boolean

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.

runAsUser

Long

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.

seLinuxOptions

io.k8s.api.core.v1.SELinuxOptions object

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.

seccompProfile

io.k8s.api.core.v1.SeccompProfile object

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.

windowsOptions

io.k8s.api.core.v1.WindowsSecurityContextOptions object

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.

表37 io.k8s.api.core.v1.Capabilities

参数

是否必选

参数类型

描述

add

Array of strings

Added capabilities

drop

Array of strings

Removed capabilities

表38 io.k8s.api.core.v1.Probe

参数

是否必选

参数类型

描述

exec

io.k8s.api.core.v1.ExecAction object

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

failureThreshold

Integer

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

httpGet

io.k8s.api.core.v1.HTTPGetAction object

HTTPGet specifies the http request to perform.

initialDelaySeconds

Integer

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

periodSeconds

Integer

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

successThreshold

Integer

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

tcpSocket

io.k8s.api.core.v1.TCPSocketAction object

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

timeoutSeconds

Integer

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

表39 io.k8s.api.core.v1.ExecAction

参数

是否必选

参数类型

描述

command

Array of strings

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

表40 io.k8s.api.core.v1.HTTPGetAction

参数

是否必选

参数类型

描述

host

String

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

httpHeaders

Array of io.k8s.api.core.v1.HTTPHeader objects

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

path

String

Path to access on the HTTP server.

port

String

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.

scheme

String

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

表41 io.k8s.api.core.v1.HTTPHeader

参数

是否必选

参数类型

描述

name

String

The header field name

value

String

The header field value

表42 io.k8s.api.core.v1.TCPSocketAction

参数

是否必选

参数类型

描述

host

String

Optional: Host name to connect to, defaults to the pod IP.

port

String

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.

表43 io.k8s.api.core.v1.VolumeDevice

参数

是否必选

参数类型

描述

devicePath

String

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

name

String

name must match the name of a persistentVolumeClaim in the pod

表44 io.k8s.api.core.v1.VolumeMount

参数

是否必选

参数类型

描述

extendPathMode

String

Extend the volume path by appending the pod metadata to the path according to specified pattern. which provide a way of directory isolation and help prevent the writing conflict between different pods.

mountPath

String

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

mountPropagation

String

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.

name

String

This must match the Name of a Volume.

policy

io.k8s.api.core.v1.Policy object

VolumeMount Policy.

readOnly

Boolean

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

subPath

String

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

subPathExpr

String

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.

表45 io.k8s.api.core.v1.Policy

参数

是否必选

参数类型

描述

logs

io.k8s.api.core.v1.Logs object

Logs describes log Volume and its rotate strategy.

表46 io.k8s.api.core.v1.Logs

参数

是否必选

参数类型

描述

annotations

Map<String,String>

Annotations for log.

rotate

String

Rotate strategy, including 'Daily' 'Hourly' 'Weekly'.

表47 io.k8s.api.core.v1.PodReadinessGate

参数

是否必选

参数类型

描述

conditionType

String

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

表48 io.k8s.api.core.v1.PodSecurityContext

参数

是否必选

参数类型

描述

fsGroup

Long

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.

fsGroupChangePolicy

String

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified defaults to "Always".

runAsGroup

Long

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.

runAsNonRoot

Boolean

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.

runAsUser

Long

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.

seLinuxOptions

io.k8s.api.core.v1.SELinuxOptions object

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.

seccompProfile

io.k8s.api.core.v1.SeccompProfile object

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

supplementalGroups

Array of longs

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.

sysctls

Array of io.k8s.api.core.v1.Sysctl objects

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

windowsOptions

io.k8s.api.core.v1.WindowsSecurityContextOptions object

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.

表49 io.k8s.api.core.v1.SELinuxOptions

参数

是否必选

参数类型

描述

level

String

Level is SELinux level label that applies to the container.

role

String

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

type

String

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

user

String

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

表50 io.k8s.api.core.v1.SeccompProfile

参数

是否必选

参数类型

描述

localhostProfile

String

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

type

String

type indicates which kind of seccomp profile will be applied. Valid options are:

Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

表51 io.k8s.api.core.v1.Sysctl

参数

是否必选

参数类型

描述

name

String

Name of a property to set

value

String

Value of a property to set

表52 io.k8s.api.core.v1.WindowsSecurityContextOptions

参数

是否必选

参数类型

描述

gmsaCredentialSpec

String

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.

gmsaCredentialSpecName

String

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

runAsUserName

String

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.

表53 io.k8s.api.core.v1.Toleration

参数

是否必选

参数类型

描述

effect

String

Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

key

String

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.

operator

String

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.

tolerationSeconds

Long

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.

value

String

Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

表54 io.k8s.api.core.v1.TopologySpreadConstraint

参数

是否必选

参数类型

描述

labelSelector

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

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.

maxSkew

Integer

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

topologyKey

String

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

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

表55 io.k8s.api.core.v1.Volume

参数

是否必选

参数类型

awsElasticBlockStore

io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource object

azureDisk

io.k8s.api.core.v1.AzureDiskVolumeSource object

azureFile

io.k8s.api.core.v1.AzureFileVolumeSource object

cephfs

io.k8s.api.core.v1.CephFSVolumeSource object

cinder

io.k8s.api.core.v1.CinderVolumeSource object

configMap

io.k8s.api.core.v1.ConfigMapVolumeSource object

csi

io.k8s.api.core.v1.CSIVolumeSource object

downwardAPI

io.k8s.api.core.v1.DownwardAPIVolumeSource object

emptyDir

io.k8s.api.core.v1.EmptyDirVolumeSource object

ephemeral

io.k8s.api.core.v1.EphemeralVolumeSource object

fc

io.k8s.api.core.v1.FCVolumeSource object

flexVolume

io.k8s.api.core.v1.FlexVolumeSource object

flocker

io.k8s.api.core.v1.FlockerVolumeSource object

gcePersistentDisk

io.k8s.api.core.v1.GCEPersistentDiskVolumeSource object

gitRepo

io.k8s.api.core.v1.GitRepoVolumeSource object

glusterfs

io.k8s.api.core.v1.GlusterfsVolumeSource object

hostPath

io.k8s.api.core.v1.HostPathVolumeSource object

iscsi

io.k8s.api.core.v1.ISCSIVolumeSource object

localDir

io.k8s.api.core.v1.LocalDirVolumeSource object

name

String

nfs

io.k8s.api.core.v1.NFSVolumeSource object

persistentVolumeClaim

io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource object

photonPersistentDisk

io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource object

portworxVolume

io.k8s.api.core.v1.PortworxVolumeSource object

projected

io.k8s.api.core.v1.ProjectedVolumeSource object

quobyte

io.k8s.api.core.v1.QuobyteVolumeSource object

rbd

io.k8s.api.core.v1.RBDVolumeSource object

scaleIO

io.k8s.api.core.v1.ScaleIOVolumeSource object

secret

io.k8s.api.core.v1.SecretVolumeSource object

storageos

io.k8s.api.core.v1.StorageOSVolumeSource object

vsphereVolume

io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource object

表56 io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource

参数

是否必选

参数类型

描述

fsType

String

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

partition

Integer

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

readOnly

Boolean

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

volumeID

String

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

表57 io.k8s.api.core.v1.AzureDiskVolumeSource

参数

是否必选

参数类型

描述

cachingMode

String

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

diskName

String

The Name of the data disk in the blob storage

diskURI

String

The URI the data disk in the blob storage

fsType

String

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.

kind

String

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

readOnly

Boolean

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

表58 io.k8s.api.core.v1.AzureFileVolumeSource

参数

是否必选

参数类型

描述

readOnly

Boolean

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

secretName

String

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

shareName

String

Share Name

表59 io.k8s.api.core.v1.CephFSVolumeSource

参数

是否必选

参数类型

描述

monitors

Array of strings

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: Used as the mounted root, rather than the full Ceph tree, default is /

readOnly

Boolean

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

secretFile

String

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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

user

String

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

表60 io.k8s.api.core.v1.CinderVolumeSource

参数

是否必选

参数类型

描述

fsType

String

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

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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

volumeID

String

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

表61 io.k8s.api.core.v1.ConfigMapVolumeSource

参数

是否必选

参数类型

描述

defaultMode

Integer

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

items

Array of io.k8s.api.core.v1.KeyToPath objects

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

name

String

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

optional

Boolean

Specify whether the ConfigMap or its keys must be defined

表62 io.k8s.api.core.v1.CSIVolumeSource

参数

是否必选

参数类型

描述

driver

String

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.

fsType

String

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.

nodePublishSecretRef

io.k8s.api.core.v1.LocalObjectReference object

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.

readOnly

Boolean

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

volumeAttributes

Map<String,String>

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

表63 io.k8s.api.core.v1.DownwardAPIVolumeSource

参数

是否必选

参数类型

描述

defaultMode

Integer

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

items

Array of io.k8s.api.core.v1.DownwardAPIVolumeFile objects

Items is a list of downward API volume file

表64 io.k8s.api.core.v1.EmptyDirVolumeSource

参数

是否必选

参数类型

描述

medium

String

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

sizeLimit

String

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

表65 io.k8s.api.core.v1.EphemeralVolumeSource

参数

是否必选

参数类型

描述

readOnly

Boolean

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

volumeClaimTemplate

io.k8s.api.core.v1.PersistentVolumeClaimTemplate object

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

表66 io.k8s.api.core.v1.PersistentVolumeClaimTemplate

参数

是否必选

参数类型

描述

metadata

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

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

spec

io.k8s.api.core.v1.PersistentVolumeClaimSpec object

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

表67 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

参数

是否必选

参数类型

描述

annotations

Map<String,String>

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

clusterName

String

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

creationTimestamp

String

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds

Long

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

deletionTimestamp

String

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

finalizers

Array of strings

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

generateName

String

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

generation

Long

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

labels

Map<String,String>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

managedFields

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

name

String

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

namespace

String

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

ownerReferences

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

resourceVersion

String

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

selfLink

String

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

uid

String

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

表68 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

参数

是否必选

参数类型

描述

apiVersion

String

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

fieldsType

String

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

fieldsV1

Object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

manager

String

Manager is an identifier of the workflow managing these fields.

operation

String

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

time

String

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

表69 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

参数

是否必选

参数类型

描述

apiVersion

String

API version of the referent.

blockOwnerDeletion

Boolean

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

controller

Boolean

If true, this reference points to the managing controller.

kind

String

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

name

String

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

uid

String

UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

表70 io.k8s.api.core.v1.PersistentVolumeClaimSpec

参数

是否必选

参数类型

描述

accessModes

Array of strings

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

dataSource

io.k8s.api.core.v1.TypedLocalObjectReference object

This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot - Beta) * An existing PVC (PersistentVolumeClaim) * An existing custom resource/object that implements data population (Alpha) In order to use VolumeSnapshot object types, the appropriate feature gate must be enabled (VolumeSnapshotDataSource or AnyVolumeDataSource) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the specified data source is not supported, the 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.

resources

io.k8s.api.core.v1.ResourceRequirements object

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

selector

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

A label query over volumes to consider for binding.

storageClassName

String

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

volumeMode

String

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

volumeName

String

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

表71 io.k8s.api.core.v1.TypedLocalObjectReference

参数

是否必选

参数类型

描述

apiGroup

String

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.

kind

String

Kind is the type of resource being referenced

name

String

Name is the name of resource being referenced

表72 io.k8s.api.core.v1.ResourceRequirements

参数

是否必选

参数类型

描述

limits

Map<String,String>

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

requests

Map<String,String>

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/

表73 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

参数

是否必选

参数类型

描述

matchExpressions

Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects

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

matchLabels

Map<String,String>

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

表74 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

参数

是否必选

参数类型

描述

key

String

key is the label key that the selector applies to.

operator

String

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

values

Array of strings

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

表75 io.k8s.api.core.v1.FCVolumeSource

参数

是否必选

参数类型

描述

fsType

String

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.

lun

Integer

Optional: FC target lun number

readOnly

Boolean

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

targetWWNs

Array of strings

Optional: FC target worldwide names (WWNs)

wwids

Array of strings

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

表76 io.k8s.api.core.v1.FlexVolumeSource

参数

是否必选

参数类型

描述

driver

String

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

fsType

String

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.

options

Map<String,String>

Optional: Extra command options if any.

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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.

表77 io.k8s.api.core.v1.FlockerVolumeSource

参数

是否必选

参数类型

描述

datasetName

String

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

datasetUUID

String

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

表78 io.k8s.api.core.v1.GCEPersistentDiskVolumeSource

参数

是否必选

参数类型

描述

fsType

String

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

partition

Integer

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

pdName

String

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

readOnly

Boolean

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

表79 io.k8s.api.core.v1.GitRepoVolumeSource

参数

是否必选

参数类型

描述

directory

String

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.

repository

String

Repository URL

revision

String

Commit hash for the specified revision.

表80 io.k8s.api.core.v1.GlusterfsVolumeSource

参数

是否必选

参数类型

描述

endpoints

String

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

path

String

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

readOnly

Boolean

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

表81 io.k8s.api.core.v1.HostPathVolumeSource

参数

是否必选

参数类型

描述

path

String

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

type

String

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

表82 io.k8s.api.core.v1.ISCSIVolumeSource

参数

是否必选

参数类型

描述

chapAuthDiscovery

Boolean

whether support iSCSI Discovery CHAP authentication

chapAuthSession

Boolean

whether support iSCSI Session CHAP authentication

fsType

String

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

initiatorName

String

Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]:[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] will be created for the connection.

iqn

String

Target iSCSI Qualified Name.

iscsiInterface

String

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

lun

Integer

iSCSI Target Lun number.

portals

Array of strings

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

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

CHAP Secret for iSCSI target and initiator authentication

targetPortal

String

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

表83 io.k8s.api.core.v1.LocalDirVolumeSource

参数

是否必选

参数类型

描述

sizeLimit

String

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

The serialization format is:

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] (Note that [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] may be empty, from the "" case in [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].) [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= 0 | 1 | ... | 9 [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]. | .[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "+" | "-" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "e" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | "E" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: a. No precision is lost b. No fractional digits will be emitted c. The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative.

Examples: 1.5 will be serialized as "1500m" 1.5Gi will be serialized as "1536Mi"

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

表84 io.k8s.api.core.v1.NFSVolumeSource

参数

是否必选

参数类型

描述

path

String

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

readOnly

Boolean

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

server

String

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

表85 io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource

参数

是否必选

参数类型

描述

claimName

String

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

Boolean

Will force the ReadOnly setting in VolumeMounts. Default false.

表86 io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource

参数

是否必选

参数类型

描述

fsType

String

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.

pdID

String

ID that identifies Photon Controller persistent disk

表87 io.k8s.api.core.v1.PortworxVolumeSource

参数

是否必选

参数类型

描述

fsType

String

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

Boolean

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

volumeID

String

VolumeID uniquely identifies a Portworx volume

表88 io.k8s.api.core.v1.ProjectedVolumeSource

参数

是否必选

参数类型

描述

defaultMode

Integer

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

sources

Array of io.k8s.api.core.v1.VolumeProjection objects

list of volume projections

表89 io.k8s.api.core.v1.VolumeProjection

参数

是否必选

参数类型

描述

configMap

io.k8s.api.core.v1.ConfigMapProjection object

information about the configMap data to project

downwardAPI

io.k8s.api.core.v1.DownwardAPIProjection object

information about the downwardAPI data to project

secret

io.k8s.api.core.v1.SecretProjection object

information about the secret data to project

serviceAccountToken

io.k8s.api.core.v1.ServiceAccountTokenProjection object

information about the serviceAccountToken data to project

表90 io.k8s.api.core.v1.ConfigMapProjection

参数

是否必选

参数类型

描述

items

Array of io.k8s.api.core.v1.KeyToPath objects

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

name

String

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

optional

Boolean

Specify whether the ConfigMap or its keys must be defined

表91 io.k8s.api.core.v1.DownwardAPIProjection

参数

是否必选

参数类型

描述

items

Array of io.k8s.api.core.v1.DownwardAPIVolumeFile objects

Items is a list of DownwardAPIVolume file

表92 io.k8s.api.core.v1.DownwardAPIVolumeFile

参数

是否必选

参数类型

描述

fieldRef

io.k8s.api.core.v1.ObjectFieldSelector object

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

mode

Integer

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

path

String

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

resourceFieldRef

io.k8s.api.core.v1.ResourceFieldSelector object

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

表93 io.k8s.api.core.v1.ObjectFieldSelector

参数

是否必选

参数类型

描述

apiVersion

String

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

fieldPath

String

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

表94 io.k8s.api.core.v1.ResourceFieldSelector

参数

是否必选

参数类型

描述

containerName

String

Container name: required for volumes, optional for env vars

divisor

String

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

resource

String

Required: resource to select

表95 io.k8s.api.core.v1.SecretProjection

参数

是否必选

参数类型

描述

items

Array of io.k8s.api.core.v1.KeyToPath objects

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

name

String

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

optional

Boolean

Specify whether the Secret or its key must be defined

表96 io.k8s.api.core.v1.ServiceAccountTokenProjection

参数

是否必选

参数类型

描述

audience

String

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.

expirationSeconds

Long

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.

path

String

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

表97 io.k8s.api.core.v1.QuobyteVolumeSource

参数

是否必选

参数类型

描述

group

String

Group to map volume access to Default is no group

readOnly

Boolean

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

registry

String

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

tenant

String

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

user

String

User to map volume access to Defaults to serivceaccount user

volume

String

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

表98 io.k8s.api.core.v1.RBDVolumeSource

参数

是否必选

参数类型

描述

fsType

String

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

image

String

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

keyring

String

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

monitors

Array of strings

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

pool

String

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

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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

user

String

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

表99 io.k8s.api.core.v1.ScaleIOVolumeSource

参数

是否必选

参数类型

描述

fsType

String

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

gateway

String

The host address of the ScaleIO API Gateway.

protectionDomain

String

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

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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

sslEnabled

Boolean

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

storageMode

String

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

storagePool

String

The ScaleIO Storage Pool associated with the protection domain.

system

String

The name of the storage system as configured in ScaleIO.

volumeName

String

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

表100 io.k8s.api.core.v1.SecretVolumeSource

参数

是否必选

参数类型

描述

defaultMode

Integer

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

items

Array of io.k8s.api.core.v1.KeyToPath objects

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

Boolean

Specify whether the Secret or its keys must be defined

secretName

String

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

表101 io.k8s.api.core.v1.KeyToPath

参数

是否必选

参数类型

描述

key

String

The key to project.

mode

Integer

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

path

String

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

表102 io.k8s.api.core.v1.StorageOSVolumeSource

参数

是否必选

参数类型

描述

fsType

String

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.

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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

volumeName

String

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

volumeNamespace

String

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.

表103 io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource

参数

是否必选

参数类型

描述

fsType

String

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.

storagePolicyID

String

Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

storagePolicyName

String

Storage Policy Based Management (SPBM) profile name.

volumePath

String

Path that identifies vSphere volume vmdk

表104 io.k8s.api.apps.v1.DeploymentStatus

参数

是否必选

参数类型

描述

availableReplicas

Integer

Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.

collisionCount

Integer

Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.

conditions

Array of io.k8s.api.apps.v1.DeploymentCondition objects

Represents the latest available observations of a deployment's current state.

observedGeneration

Long

The generation observed by the deployment controller.

readyReplicas

Integer

Total number of ready pods targeted by this deployment.

replicas

Integer

Total number of non-terminated pods targeted by this deployment (their labels match the selector).

unavailableReplicas

Integer

Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.

updatedReplicas

Integer

Total number of non-terminated pods targeted by this deployment that have the desired template spec.

表105 io.k8s.api.apps.v1.DeploymentCondition

参数

是否必选

参数类型

描述

lastTransitionTime

String

Last time the condition transitioned from one status to another.

lastUpdateTime

String

The last time this condition was updated.

message

String

A human readable message indicating details about the transition.

reason

String

The reason for the condition's last transition.

status

String

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

type

String

Type of deployment condition.

响应参数

状态码: 200

表106 响应Body参数

参数

参数类型

描述

apiVersion

String

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

String

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

Standard object metadata.

spec

io.k8s.api.apps.v1.DeploymentSpec object

Specification of the desired behavior of the Deployment.

status

io.k8s.api.apps.v1.DeploymentStatus object

Most recently observed status of the Deployment.

表107 io.k8s.api.apps.v1.DeploymentSpec

参数

参数类型

描述

minReadySeconds

Integer

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)

paused

Boolean

Indicates that the deployment is paused.

progressDeadlineSeconds

Integer

The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.

replicas

Integer

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

revisionHistoryLimit

Integer

The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.

selector

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.

strategy

io.k8s.api.apps.v1.DeploymentStrategy object

The deployment strategy to use to replace existing pods with new ones.

template

io.k8s.api.core.v1.PodTemplateSpec object

Template describes the pods that will be created.

表108 io.k8s.api.apps.v1.DeploymentStrategy

参数

参数类型

描述

rollingUpdate

io.k8s.api.apps.v1.RollingUpdateDeployment object

Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.

type

String

Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

表109 io.k8s.api.apps.v1.RollingUpdateDeployment

参数

参数类型

描述

maxSurge

String

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.

maxUnavailable

String

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

表110 io.k8s.api.core.v1.PodTemplateSpec

参数

参数类型

描述

metadata

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

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

spec

io.k8s.api.core.v1.PodSpec object

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

表111 io.k8s.api.core.v1.PodSpec

参数

参数类型

activeDeadlineSeconds

Long

affinity

io.k8s.api.core.v1.Affinity object

automountServiceAccountToken

Boolean

containers

Array of io.k8s.api.core.v1.Container objects

dnsConfig

io.k8s.api.core.v1.PodDNSConfig object

dnsPolicy

String

enableServiceLinks

Boolean

ephemeralContainers

Array of io.k8s.api.core.v1.EphemeralContainer objects

hostAliases

Array of io.k8s.api.core.v1.HostAlias objects

hostIPC

Boolean

hostNetwork

Boolean

hostPID

Boolean

hostname

String

imagePullSecrets

Array of io.k8s.api.core.v1.LocalObjectReference objects

initContainers

Array of io.k8s.api.core.v1.Container objects

nodeName

String

nodeSelector

Map<String,String>

overhead

Map<String,String>

preemptionPolicy

String

priority

Integer

priorityClassName

String

readinessGates

Array of io.k8s.api.core.v1.PodReadinessGate objects

restartPolicy

String

runtimeClassName

String

schedulerName

String

securityContext

io.k8s.api.core.v1.PodSecurityContext object

serviceAccount

String

serviceAccountName

String

setHostnameAsFQDN

Boolean

shareProcessNamespace

Boolean

subdomain

String

terminationGracePeriodSeconds

Long

tolerations

Array of io.k8s.api.core.v1.Toleration objects

topologySpreadConstraints

Array of io.k8s.api.core.v1.TopologySpreadConstraint objects

volumes

Array of io.k8s.api.core.v1.Volume objects

表112 io.k8s.api.core.v1.Affinity

参数

参数类型

描述

nodeAffinity

io.k8s.api.core.v1.NodeAffinity object

Describes node affinity scheduling rules for the pod.

podAffinity

io.k8s.api.core.v1.PodAffinity object

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

podAntiAffinity

io.k8s.api.core.v1.PodAntiAffinity object

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

表113 io.k8s.api.core.v1.NodeAffinity

参数

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of io.k8s.api.core.v1.PreferredSchedulingTerm objects

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.

requiredDuringSchedulingIgnoredDuringExecution

io.k8s.api.core.v1.NodeSelector object

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.

表114 io.k8s.api.core.v1.PreferredSchedulingTerm

参数

参数类型

描述

preference

io.k8s.api.core.v1.NodeSelectorTerm object

A node selector term, associated with the corresponding weight.

weight

Integer

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

表115 io.k8s.api.core.v1.NodeSelectorTerm

参数

参数类型

描述

matchExpressions

Array of io.k8s.api.core.v1.NodeSelectorRequirement objects

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

matchFields

Array of io.k8s.api.core.v1.NodeSelectorRequirement objects

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

表116 io.k8s.api.core.v1.NodeSelector

参数

参数类型

描述

nodeSelectorTerms

Array of io.k8s.api.core.v1.NodeSelectorTerm objects

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

表117 io.k8s.api.core.v1.NodeSelectorRequirement

参数

参数类型

描述

key

String

The label key that the selector applies to.

operator

String

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

values

Array of strings

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.

表118 io.k8s.api.core.v1.PodAffinity

参数

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of io.k8s.api.core.v1.WeightedPodAffinityTerm objects

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.

requiredDuringSchedulingIgnoredDuringExecution

Array of io.k8s.api.core.v1.PodAffinityTerm objects

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.

表119 io.k8s.api.core.v1.PodAntiAffinity

参数

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of io.k8s.api.core.v1.WeightedPodAffinityTerm objects

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.

requiredDuringSchedulingIgnoredDuringExecution

Array of io.k8s.api.core.v1.PodAffinityTerm objects

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.

表120 io.k8s.api.core.v1.WeightedPodAffinityTerm

参数

参数类型

描述

podAffinityTerm

io.k8s.api.core.v1.PodAffinityTerm object

Required. A pod affinity term, associated with the corresponding weight.

weight

Integer

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

表121 io.k8s.api.core.v1.PodAffinityTerm

参数

参数类型

描述

labelSelector

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

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

namespaces

Array of strings

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

topologyKey

String

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.

表122 io.k8s.api.core.v1.PodDNSConfig

参数

参数类型

描述

nameservers

Array of strings

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

options

Array of io.k8s.api.core.v1.PodDNSConfigOption objects

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.

searches

Array of strings

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.

表123 io.k8s.api.core.v1.PodDNSConfigOption

参数

参数类型

描述

name

String

Required.

value

String

value is the value of the option

表124 io.k8s.api.core.v1.EphemeralContainer

参数

参数类型

描述

args

Array of strings

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

command

Array of strings

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

env

Array of io.k8s.api.core.v1.EnvVar objects

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

envFrom

Array of io.k8s.api.core.v1.EnvFromSource objects

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.

image

String

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

imagePullPolicy

String

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

lifecycle

io.k8s.api.core.v1.Lifecycle object

Lifecycle is not allowed for ephemeral containers.

livenessProbe

io.k8s.api.core.v1.Probe object

Probes are not allowed for ephemeral containers.

name

String

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

ports

Array of io.k8s.api.core.v1.ContainerPort objects

Ports are not allowed for ephemeral containers.

readinessProbe

io.k8s.api.core.v1.Probe object

Probes are not allowed for ephemeral containers.

resources

io.k8s.api.core.v1.ResourceRequirements object

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

securityContext

io.k8s.api.core.v1.SecurityContext object

SecurityContext is not allowed for ephemeral containers.

startupProbe

io.k8s.api.core.v1.Probe object

Probes are not allowed for ephemeral containers.

stdin

Boolean

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.

stdinOnce

Boolean

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

targetContainerName

String

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.

terminationMessagePath

String

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.

terminationMessagePolicy

String

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.

tty

Boolean

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

volumeDevices

Array of io.k8s.api.core.v1.VolumeDevice objects

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

volumeMounts

Array of io.k8s.api.core.v1.VolumeMount objects

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

workingDir

String

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.

表125 io.k8s.api.core.v1.HostAlias

参数

参数类型

描述

hostnames

Array of strings

Hostnames for the above IP address.

ip

String

IP address of the host file entry.

表126 io.k8s.api.core.v1.LocalObjectReference

参数

参数类型

描述

name

String

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

表127 io.k8s.api.core.v1.Container

参数

参数类型

描述

args

Array of strings

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

command

Array of strings

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

env

Array of io.k8s.api.core.v1.EnvVar objects

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

envFrom

Array of io.k8s.api.core.v1.EnvFromSource objects

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.

image

String

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.

imagePullPolicy

String

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

lifecycle

io.k8s.api.core.v1.Lifecycle object

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

livenessProbe

io.k8s.api.core.v1.Probe object

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

name

String

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

ports

Array of io.k8s.api.core.v1.ContainerPort objects

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.

readinessProbe

io.k8s.api.core.v1.Probe object

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

resources

io.k8s.api.core.v1.ResourceRequirements object

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

securityContext

io.k8s.api.core.v1.SecurityContext object

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/

startupProbe

io.k8s.api.core.v1.Probe object

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

stdin

Boolean

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.

stdinOnce

Boolean

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

terminationMessagePath

String

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.

terminationMessagePolicy

String

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.

tty

Boolean

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

volumeDevices

Array of io.k8s.api.core.v1.VolumeDevice objects

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

volumeMounts

Array of io.k8s.api.core.v1.VolumeMount objects

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

workingDir

String

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.

表128 io.k8s.api.core.v1.EnvVar

参数

参数类型

描述

name

String

Name of the environment variable. Must be a C_IDENTIFIER.

value

String

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

valueFrom

io.k8s.api.core.v1.EnvVarSource object

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

表129 io.k8s.api.core.v1.EnvVarSource

参数

参数类型

描述

configMapKeyRef

io.k8s.api.core.v1.ConfigMapKeySelector object

Selects a key of a ConfigMap.

fieldRef

io.k8s.api.core.v1.ObjectFieldSelector object

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

resourceFieldRef

io.k8s.api.core.v1.ResourceFieldSelector object

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.

secretKeyRef

io.k8s.api.core.v1.SecretKeySelector object

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

表130 io.k8s.api.core.v1.ConfigMapKeySelector

参数

参数类型

描述

key

String

The key to select.

name

String

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

optional

Boolean

Specify whether the ConfigMap or its key must be defined

表131 io.k8s.api.core.v1.SecretKeySelector

参数

参数类型

描述

key

String

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

name

String

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

optional

Boolean

Specify whether the Secret or its key must be defined

表132 io.k8s.api.core.v1.EnvFromSource

参数

参数类型

描述

configMapRef

io.k8s.api.core.v1.ConfigMapEnvSource object

The ConfigMap to select from

prefix

String

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

secretRef

io.k8s.api.core.v1.SecretEnvSource object

The Secret to select from

表133 io.k8s.api.core.v1.ConfigMapEnvSource

参数

参数类型

描述

name

String

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

optional

Boolean

Specify whether the ConfigMap must be defined

表134 io.k8s.api.core.v1.SecretEnvSource

参数

参数类型

描述

name

String

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

optional

Boolean

Specify whether the Secret must be defined

表135 io.k8s.api.core.v1.Lifecycle

参数

参数类型

描述

postStart

io.k8s.api.core.v1.Handler object

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

preStop

io.k8s.api.core.v1.Handler object

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

表136 io.k8s.api.core.v1.Handler

参数

参数类型

描述

exec

io.k8s.api.core.v1.ExecAction object

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

httpGet

io.k8s.api.core.v1.HTTPGetAction object

HTTPGet specifies the http request to perform.

tcpSocket

io.k8s.api.core.v1.TCPSocketAction object

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

表137 io.k8s.api.core.v1.ContainerPort

参数

参数类型

描述

containerPort

Integer

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

hostIP

String

What host IP to bind the external port to.

hostPort

Integer

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.

name

String

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.

protocol

String

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

表138 io.k8s.api.core.v1.SecurityContext

参数

参数类型

描述

allowPrivilegeEscalation

Boolean

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

capabilities

io.k8s.api.core.v1.Capabilities object

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

privileged

Boolean

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

procMount

String

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.

readOnlyRootFilesystem

Boolean

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

runAsGroup

Long

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.

runAsNonRoot

Boolean

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.

runAsUser

Long

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.

seLinuxOptions

io.k8s.api.core.v1.SELinuxOptions object

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.

seccompProfile

io.k8s.api.core.v1.SeccompProfile object

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.

windowsOptions

io.k8s.api.core.v1.WindowsSecurityContextOptions object

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.

表139 io.k8s.api.core.v1.Capabilities

参数

参数类型

描述

add

Array of strings

Added capabilities

drop

Array of strings

Removed capabilities

表140 io.k8s.api.core.v1.Probe

参数

参数类型

描述

exec

io.k8s.api.core.v1.ExecAction object

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

failureThreshold

Integer

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

httpGet

io.k8s.api.core.v1.HTTPGetAction object

HTTPGet specifies the http request to perform.

initialDelaySeconds

Integer

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

periodSeconds

Integer

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

successThreshold

Integer

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

tcpSocket

io.k8s.api.core.v1.TCPSocketAction object

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

timeoutSeconds

Integer

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

表141 io.k8s.api.core.v1.ExecAction

参数

参数类型

描述

command

Array of strings

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

表142 io.k8s.api.core.v1.HTTPGetAction

参数

参数类型

描述

host

String

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

httpHeaders

Array of io.k8s.api.core.v1.HTTPHeader objects

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

path

String

Path to access on the HTTP server.

port

String

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.

scheme

String

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

表143 io.k8s.api.core.v1.HTTPHeader

参数

参数类型

描述

name

String

The header field name

value

String

The header field value

表144 io.k8s.api.core.v1.TCPSocketAction

参数

参数类型

描述

host

String

Optional: Host name to connect to, defaults to the pod IP.

port

String

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.

表145 io.k8s.api.core.v1.VolumeDevice

参数

参数类型

描述

devicePath

String

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

name

String

name must match the name of a persistentVolumeClaim in the pod

表146 io.k8s.api.core.v1.VolumeMount

参数

参数类型

描述

extendPathMode

String

Extend the volume path by appending the pod metadata to the path according to specified pattern. which provide a way of directory isolation and help prevent the writing conflict between different pods.

mountPath

String

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

mountPropagation

String

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.

name

String

This must match the Name of a Volume.

policy

io.k8s.api.core.v1.Policy object

VolumeMount Policy.

readOnly

Boolean

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

subPath

String

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

subPathExpr

String

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.

表147 io.k8s.api.core.v1.Policy

参数

参数类型

描述

logs

io.k8s.api.core.v1.Logs object

Logs describes log Volume and its rotate strategy.

表148 io.k8s.api.core.v1.Logs

参数

参数类型

描述

annotations

Map<String,String>

Annotations for log.

rotate

String

Rotate strategy, including 'Daily' 'Hourly' 'Weekly'.

表149 io.k8s.api.core.v1.PodReadinessGate

参数

参数类型

描述

conditionType

String

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

表150 io.k8s.api.core.v1.PodSecurityContext

参数

参数类型

描述

fsGroup

Long

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.

fsGroupChangePolicy

String

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified defaults to "Always".

runAsGroup

Long

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.

runAsNonRoot

Boolean

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.

runAsUser

Long

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.

seLinuxOptions

io.k8s.api.core.v1.SELinuxOptions object

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.

seccompProfile

io.k8s.api.core.v1.SeccompProfile object

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

supplementalGroups

Array of longs

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.

sysctls

Array of io.k8s.api.core.v1.Sysctl objects

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

windowsOptions

io.k8s.api.core.v1.WindowsSecurityContextOptions object

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.

表151 io.k8s.api.core.v1.SELinuxOptions

参数

参数类型

描述

level

String

Level is SELinux level label that applies to the container.

role

String

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

type

String

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

user

String

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

表152 io.k8s.api.core.v1.SeccompProfile

参数

参数类型

描述

localhostProfile

String

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

type

String

type indicates which kind of seccomp profile will be applied. Valid options are:

Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

表153 io.k8s.api.core.v1.Sysctl

参数

参数类型

描述

name

String

Name of a property to set

value

String

Value of a property to set

表154 io.k8s.api.core.v1.WindowsSecurityContextOptions

参数

参数类型

描述

gmsaCredentialSpec

String

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.

gmsaCredentialSpecName

String

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

runAsUserName

String

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.

表155 io.k8s.api.core.v1.Toleration

参数

参数类型

描述

effect

String

Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

key

String

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.

operator

String

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.

tolerationSeconds

Long

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.

value

String

Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

表156 io.k8s.api.core.v1.TopologySpreadConstraint

参数

参数类型

描述

labelSelector

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

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.

maxSkew

Integer

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

topologyKey

String

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

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

表157 io.k8s.api.core.v1.Volume

参数

参数类型

awsElasticBlockStore

io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource object

azureDisk

io.k8s.api.core.v1.AzureDiskVolumeSource object

azureFile

io.k8s.api.core.v1.AzureFileVolumeSource object

cephfs

io.k8s.api.core.v1.CephFSVolumeSource object

cinder

io.k8s.api.core.v1.CinderVolumeSource object

configMap

io.k8s.api.core.v1.ConfigMapVolumeSource object

csi

io.k8s.api.core.v1.CSIVolumeSource object

downwardAPI

io.k8s.api.core.v1.DownwardAPIVolumeSource object

emptyDir

io.k8s.api.core.v1.EmptyDirVolumeSource object

ephemeral

io.k8s.api.core.v1.EphemeralVolumeSource object

fc

io.k8s.api.core.v1.FCVolumeSource object

flexVolume

io.k8s.api.core.v1.FlexVolumeSource object

flocker

io.k8s.api.core.v1.FlockerVolumeSource object

gcePersistentDisk

io.k8s.api.core.v1.GCEPersistentDiskVolumeSource object

gitRepo

io.k8s.api.core.v1.GitRepoVolumeSource object

glusterfs

io.k8s.api.core.v1.GlusterfsVolumeSource object

hostPath

io.k8s.api.core.v1.HostPathVolumeSource object

iscsi

io.k8s.api.core.v1.ISCSIVolumeSource object

localDir

io.k8s.api.core.v1.LocalDirVolumeSource object

name

String

nfs

io.k8s.api.core.v1.NFSVolumeSource object

persistentVolumeClaim

io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource object

photonPersistentDisk

io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource object

portworxVolume

io.k8s.api.core.v1.PortworxVolumeSource object

projected

io.k8s.api.core.v1.ProjectedVolumeSource object

quobyte

io.k8s.api.core.v1.QuobyteVolumeSource object

rbd

io.k8s.api.core.v1.RBDVolumeSource object

scaleIO

io.k8s.api.core.v1.ScaleIOVolumeSource object

secret

io.k8s.api.core.v1.SecretVolumeSource object

storageos

io.k8s.api.core.v1.StorageOSVolumeSource object

vsphereVolume

io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource object

表158 io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource

参数

参数类型

描述

fsType

String

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

partition

Integer

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

readOnly

Boolean

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

volumeID

String

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

表159 io.k8s.api.core.v1.AzureDiskVolumeSource

参数

参数类型

描述

cachingMode

String

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

diskName

String

The Name of the data disk in the blob storage

diskURI

String

The URI the data disk in the blob storage

fsType

String

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.

kind

String

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

readOnly

Boolean

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

表160 io.k8s.api.core.v1.AzureFileVolumeSource

参数

参数类型

描述

readOnly

Boolean

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

secretName

String

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

shareName

String

Share Name

表161 io.k8s.api.core.v1.CephFSVolumeSource

参数

参数类型

描述

monitors

Array of strings

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: Used as the mounted root, rather than the full Ceph tree, default is /

readOnly

Boolean

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

secretFile

String

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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

user

String

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

表162 io.k8s.api.core.v1.CinderVolumeSource

参数

参数类型

描述

fsType

String

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

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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

volumeID

String

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

表163 io.k8s.api.core.v1.ConfigMapVolumeSource

参数

参数类型

描述

defaultMode

Integer

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

items

Array of io.k8s.api.core.v1.KeyToPath objects

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

name

String

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

optional

Boolean

Specify whether the ConfigMap or its keys must be defined

表164 io.k8s.api.core.v1.CSIVolumeSource

参数

参数类型

描述

driver

String

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.

fsType

String

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.

nodePublishSecretRef

io.k8s.api.core.v1.LocalObjectReference object

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.

readOnly

Boolean

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

volumeAttributes

Map<String,String>

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

表165 io.k8s.api.core.v1.DownwardAPIVolumeSource

参数

参数类型

描述

defaultMode

Integer

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

items

Array of io.k8s.api.core.v1.DownwardAPIVolumeFile objects

Items is a list of downward API volume file

表166 io.k8s.api.core.v1.EmptyDirVolumeSource

参数

参数类型

描述

medium

String

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

sizeLimit

String

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

表167 io.k8s.api.core.v1.EphemeralVolumeSource

参数

参数类型

描述

readOnly

Boolean

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

volumeClaimTemplate

io.k8s.api.core.v1.PersistentVolumeClaimTemplate object

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

表168 io.k8s.api.core.v1.PersistentVolumeClaimTemplate

参数

参数类型

描述

metadata

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

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

spec

io.k8s.api.core.v1.PersistentVolumeClaimSpec object

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

表169 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

参数

参数类型

描述

annotations

Map<String,String>

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

clusterName

String

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

creationTimestamp

String

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds

Long

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

deletionTimestamp

String

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

finalizers

Array of strings

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

generateName

String

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

generation

Long

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

labels

Map<String,String>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

managedFields

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

name

String

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

namespace

String

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

ownerReferences

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

resourceVersion

String

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

selfLink

String

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

uid

String

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

表170 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

参数

参数类型

描述

apiVersion

String

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

fieldsType

String

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

fieldsV1

Object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

manager

String

Manager is an identifier of the workflow managing these fields.

operation

String

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

time

String

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

表171 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

参数

参数类型

描述

apiVersion

String

API version of the referent.

blockOwnerDeletion

Boolean

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

controller

Boolean

If true, this reference points to the managing controller.

kind

String

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

name

String

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

uid

String

UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

表172 io.k8s.api.core.v1.PersistentVolumeClaimSpec

参数

参数类型

描述

accessModes

Array of strings

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

dataSource

io.k8s.api.core.v1.TypedLocalObjectReference object

This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot - Beta) * An existing PVC (PersistentVolumeClaim) * An existing custom resource/object that implements data population (Alpha) In order to use VolumeSnapshot object types, the appropriate feature gate must be enabled (VolumeSnapshotDataSource or AnyVolumeDataSource) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the specified data source is not supported, the 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.

resources

io.k8s.api.core.v1.ResourceRequirements object

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

selector

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

A label query over volumes to consider for binding.

storageClassName

String

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

volumeMode

String

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

volumeName

String

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

表173 io.k8s.api.core.v1.TypedLocalObjectReference

参数

参数类型

描述

apiGroup

String

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.

kind

String

Kind is the type of resource being referenced

name

String

Name is the name of resource being referenced

表174 io.k8s.api.core.v1.ResourceRequirements

参数

参数类型

描述

limits

Map<String,String>

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

requests

Map<String,String>

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/

表175 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

参数

参数类型

描述

matchExpressions

Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects

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

matchLabels

Map<String,String>

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

表176 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

参数

参数类型

描述

key

String

key is the label key that the selector applies to.

operator

String

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

values

Array of strings

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

表177 io.k8s.api.core.v1.FCVolumeSource

参数

参数类型

描述

fsType

String

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.

lun

Integer

Optional: FC target lun number

readOnly

Boolean

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

targetWWNs

Array of strings

Optional: FC target worldwide names (WWNs)

wwids

Array of strings

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

表178 io.k8s.api.core.v1.FlexVolumeSource

参数

参数类型

描述

driver

String

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

fsType

String

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.

options

Map<String,String>

Optional: Extra command options if any.

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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.

表179 io.k8s.api.core.v1.FlockerVolumeSource

参数

参数类型

描述

datasetName

String

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

datasetUUID

String

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

表180 io.k8s.api.core.v1.GCEPersistentDiskVolumeSource

参数

参数类型

描述

fsType

String

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

partition

Integer

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

pdName

String

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

readOnly

Boolean

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

表181 io.k8s.api.core.v1.GitRepoVolumeSource

参数

参数类型

描述

directory

String

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.

repository

String

Repository URL

revision

String

Commit hash for the specified revision.

表182 io.k8s.api.core.v1.GlusterfsVolumeSource

参数

参数类型

描述

endpoints

String

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

path

String

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

readOnly

Boolean

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

表183 io.k8s.api.core.v1.HostPathVolumeSource

参数

参数类型

描述

path

String

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

type

String

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

表184 io.k8s.api.core.v1.ISCSIVolumeSource

参数

参数类型

描述

chapAuthDiscovery

Boolean

whether support iSCSI Discovery CHAP authentication

chapAuthSession

Boolean

whether support iSCSI Session CHAP authentication

fsType

String

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

initiatorName

String

Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]:[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] will be created for the connection.

iqn

String

Target iSCSI Qualified Name.

iscsiInterface

String

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

lun

Integer

iSCSI Target Lun number.

portals

Array of strings

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

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

CHAP Secret for iSCSI target and initiator authentication

targetPortal

String

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

表185 io.k8s.api.core.v1.LocalDirVolumeSource

参数

参数类型

描述

sizeLimit

String

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

The serialization format is:

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] (Note that [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] may be empty, from the "" case in [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].) [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= 0 | 1 | ... | 9 [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]. | .[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "+" | "-" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "e" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | "E" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: a. No precision is lost b. No fractional digits will be emitted c. The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative.

Examples: 1.5 will be serialized as "1500m" 1.5Gi will be serialized as "1536Mi"

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

表186 io.k8s.api.core.v1.NFSVolumeSource

参数

参数类型

描述

path

String

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

readOnly

Boolean

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

server

String

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

表187 io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource

参数

参数类型

描述

claimName

String

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

Boolean

Will force the ReadOnly setting in VolumeMounts. Default false.

表188 io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource

参数

参数类型

描述

fsType

String

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.

pdID

String

ID that identifies Photon Controller persistent disk

表189 io.k8s.api.core.v1.PortworxVolumeSource

参数

参数类型

描述

fsType

String

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

Boolean

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

volumeID

String

VolumeID uniquely identifies a Portworx volume

表190 io.k8s.api.core.v1.ProjectedVolumeSource

参数

参数类型

描述

defaultMode

Integer

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

sources

Array of io.k8s.api.core.v1.VolumeProjection objects

list of volume projections

表191 io.k8s.api.core.v1.VolumeProjection

参数

参数类型

描述

configMap

io.k8s.api.core.v1.ConfigMapProjection object

information about the configMap data to project

downwardAPI

io.k8s.api.core.v1.DownwardAPIProjection object

information about the downwardAPI data to project

secret

io.k8s.api.core.v1.SecretProjection object

information about the secret data to project

serviceAccountToken

io.k8s.api.core.v1.ServiceAccountTokenProjection object

information about the serviceAccountToken data to project

表192 io.k8s.api.core.v1.ConfigMapProjection

参数

参数类型

描述

items

Array of io.k8s.api.core.v1.KeyToPath objects

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

name

String

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

optional

Boolean

Specify whether the ConfigMap or its keys must be defined

表193 io.k8s.api.core.v1.DownwardAPIProjection

参数

参数类型

描述

items

Array of io.k8s.api.core.v1.DownwardAPIVolumeFile objects

Items is a list of DownwardAPIVolume file

表194 io.k8s.api.core.v1.DownwardAPIVolumeFile

参数

参数类型

描述

fieldRef

io.k8s.api.core.v1.ObjectFieldSelector object

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

mode

Integer

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

path

String

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

resourceFieldRef

io.k8s.api.core.v1.ResourceFieldSelector object

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

表195 io.k8s.api.core.v1.ObjectFieldSelector

参数

参数类型

描述

apiVersion

String

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

fieldPath

String

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

表196 io.k8s.api.core.v1.ResourceFieldSelector

参数

参数类型

描述

containerName

String

Container name: required for volumes, optional for env vars

divisor

String

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

resource

String

Required: resource to select

表197 io.k8s.api.core.v1.SecretProjection

参数

参数类型

描述

items

Array of io.k8s.api.core.v1.KeyToPath objects

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

name

String

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

optional

Boolean

Specify whether the Secret or its key must be defined

表198 io.k8s.api.core.v1.ServiceAccountTokenProjection

参数

参数类型

描述

audience

String

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.

expirationSeconds

Long

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.

path

String

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

表199 io.k8s.api.core.v1.QuobyteVolumeSource

参数

参数类型

描述

group

String

Group to map volume access to Default is no group

readOnly

Boolean

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

registry

String

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

tenant

String

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

user

String

User to map volume access to Defaults to serivceaccount user

volume

String

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

表200 io.k8s.api.core.v1.RBDVolumeSource

参数

参数类型

描述

fsType

String

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

image

String

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

keyring

String

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

monitors

Array of strings

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

pool

String

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

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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

user

String

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

表201 io.k8s.api.core.v1.ScaleIOVolumeSource

参数

参数类型

描述

fsType

String

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

gateway

String

The host address of the ScaleIO API Gateway.

protectionDomain

String

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

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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

sslEnabled

Boolean

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

storageMode

String

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

storagePool

String

The ScaleIO Storage Pool associated with the protection domain.

system

String

The name of the storage system as configured in ScaleIO.

volumeName

String

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

表202 io.k8s.api.core.v1.SecretVolumeSource

参数

参数类型

描述

defaultMode

Integer

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

items

Array of io.k8s.api.core.v1.KeyToPath objects

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

Boolean

Specify whether the Secret or its keys must be defined

secretName

String

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

表203 io.k8s.api.core.v1.KeyToPath

参数

参数类型

描述

key

String

The key to project.

mode

Integer

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

path

String

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

表204 io.k8s.api.core.v1.StorageOSVolumeSource

参数

参数类型

描述

fsType

String

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.

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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

volumeName

String

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

volumeNamespace

String

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.

表205 io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource

参数

参数类型

描述

fsType

String

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.

storagePolicyID

String

Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

storagePolicyName

String

Storage Policy Based Management (SPBM) profile name.

volumePath

String

Path that identifies vSphere volume vmdk

表206 io.k8s.api.apps.v1.DeploymentStatus

参数

参数类型

描述

availableReplicas

Integer

Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.

collisionCount

Integer

Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.

conditions

Array of io.k8s.api.apps.v1.DeploymentCondition objects

Represents the latest available observations of a deployment's current state.

observedGeneration

Long

The generation observed by the deployment controller.

readyReplicas

Integer

Total number of ready pods targeted by this deployment.

replicas

Integer

Total number of non-terminated pods targeted by this deployment (their labels match the selector).

unavailableReplicas

Integer

Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.

updatedReplicas

Integer

Total number of non-terminated pods targeted by this deployment that have the desired template spec.

表207 io.k8s.api.apps.v1.DeploymentCondition

参数

参数类型

描述

lastTransitionTime

String

Last time the condition transitioned from one status to another.

lastUpdateTime

String

The last time this condition was updated.

message

String

A human readable message indicating details about the transition.

reason

String

The reason for the condition's last transition.

status

String

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

type

String

Type of deployment condition.

状态码: 201

表208 响应Body参数

参数

参数类型

描述

apiVersion

String

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

String

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

Standard object metadata.

spec

io.k8s.api.apps.v1.DeploymentSpec object

Specification of the desired behavior of the Deployment.

status

io.k8s.api.apps.v1.DeploymentStatus object

Most recently observed status of the Deployment.

表209 io.k8s.api.apps.v1.DeploymentSpec

参数

参数类型

描述

minReadySeconds

Integer

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)

paused

Boolean

Indicates that the deployment is paused.

progressDeadlineSeconds

Integer

The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.

replicas

Integer

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

revisionHistoryLimit

Integer

The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.

selector

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.

strategy

io.k8s.api.apps.v1.DeploymentStrategy object

The deployment strategy to use to replace existing pods with new ones.

template

io.k8s.api.core.v1.PodTemplateSpec object

Template describes the pods that will be created.

表210 io.k8s.api.apps.v1.DeploymentStrategy

参数

参数类型

描述

rollingUpdate

io.k8s.api.apps.v1.RollingUpdateDeployment object

Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.

type

String

Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

表211 io.k8s.api.apps.v1.RollingUpdateDeployment

参数

参数类型

描述

maxSurge

String

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.

maxUnavailable

String

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

表212 io.k8s.api.core.v1.PodTemplateSpec

参数

参数类型

描述

metadata

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

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

spec

io.k8s.api.core.v1.PodSpec object

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

表213 io.k8s.api.core.v1.PodSpec

参数

参数类型

activeDeadlineSeconds

Long

affinity

io.k8s.api.core.v1.Affinity object

automountServiceAccountToken

Boolean

containers

Array of io.k8s.api.core.v1.Container objects

dnsConfig

io.k8s.api.core.v1.PodDNSConfig object

dnsPolicy

String

enableServiceLinks

Boolean

ephemeralContainers

Array of io.k8s.api.core.v1.EphemeralContainer objects

hostAliases

Array of io.k8s.api.core.v1.HostAlias objects

hostIPC

Boolean

hostNetwork

Boolean

hostPID

Boolean

hostname

String

imagePullSecrets

Array of io.k8s.api.core.v1.LocalObjectReference objects

initContainers

Array of io.k8s.api.core.v1.Container objects

nodeName

String

nodeSelector

Map<String,String>

overhead

Map<String,String>

preemptionPolicy

String

priority

Integer

priorityClassName

String

readinessGates

Array of io.k8s.api.core.v1.PodReadinessGate objects

restartPolicy

String

runtimeClassName

String

schedulerName

String

securityContext

io.k8s.api.core.v1.PodSecurityContext object

serviceAccount

String

serviceAccountName

String

setHostnameAsFQDN

Boolean

shareProcessNamespace

Boolean

subdomain

String

terminationGracePeriodSeconds

Long

tolerations

Array of io.k8s.api.core.v1.Toleration objects

topologySpreadConstraints

Array of io.k8s.api.core.v1.TopologySpreadConstraint objects

volumes

Array of io.k8s.api.core.v1.Volume objects

表214 io.k8s.api.core.v1.Affinity

参数

参数类型

描述

nodeAffinity

io.k8s.api.core.v1.NodeAffinity object

Describes node affinity scheduling rules for the pod.

podAffinity

io.k8s.api.core.v1.PodAffinity object

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

podAntiAffinity

io.k8s.api.core.v1.PodAntiAffinity object

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

表215 io.k8s.api.core.v1.NodeAffinity

参数

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of io.k8s.api.core.v1.PreferredSchedulingTerm objects

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.

requiredDuringSchedulingIgnoredDuringExecution

io.k8s.api.core.v1.NodeSelector object

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.

表216 io.k8s.api.core.v1.PreferredSchedulingTerm

参数

参数类型

描述

preference

io.k8s.api.core.v1.NodeSelectorTerm object

A node selector term, associated with the corresponding weight.

weight

Integer

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

表217 io.k8s.api.core.v1.NodeSelectorTerm

参数

参数类型

描述

matchExpressions

Array of io.k8s.api.core.v1.NodeSelectorRequirement objects

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

matchFields

Array of io.k8s.api.core.v1.NodeSelectorRequirement objects

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

表218 io.k8s.api.core.v1.NodeSelector

参数

参数类型

描述

nodeSelectorTerms

Array of io.k8s.api.core.v1.NodeSelectorTerm objects

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

表219 io.k8s.api.core.v1.NodeSelectorRequirement

参数

参数类型

描述

key

String

The label key that the selector applies to.

operator

String

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

values

Array of strings

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.

表220 io.k8s.api.core.v1.PodAffinity

参数

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of io.k8s.api.core.v1.WeightedPodAffinityTerm objects

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.

requiredDuringSchedulingIgnoredDuringExecution

Array of io.k8s.api.core.v1.PodAffinityTerm objects

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.

表221 io.k8s.api.core.v1.PodAntiAffinity

参数

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of io.k8s.api.core.v1.WeightedPodAffinityTerm objects

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.

requiredDuringSchedulingIgnoredDuringExecution

Array of io.k8s.api.core.v1.PodAffinityTerm objects

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.

表222 io.k8s.api.core.v1.WeightedPodAffinityTerm

参数

参数类型

描述

podAffinityTerm

io.k8s.api.core.v1.PodAffinityTerm object

Required. A pod affinity term, associated with the corresponding weight.

weight

Integer

weight associated with matching the corresponding podAffinityTerm, in the range 1-100.

表223 io.k8s.api.core.v1.PodAffinityTerm

参数

参数类型

描述

labelSelector

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

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

namespaces

Array of strings

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

topologyKey

String

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.

表224 io.k8s.api.core.v1.PodDNSConfig

参数

参数类型

描述

nameservers

Array of strings

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

options

Array of io.k8s.api.core.v1.PodDNSConfigOption objects

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.

searches

Array of strings

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.

表225 io.k8s.api.core.v1.PodDNSConfigOption

参数

参数类型

描述

name

String

Required.

value

String

value is the value of the option

表226 io.k8s.api.core.v1.EphemeralContainer

参数

参数类型

描述

args

Array of strings

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

command

Array of strings

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

env

Array of io.k8s.api.core.v1.EnvVar objects

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

envFrom

Array of io.k8s.api.core.v1.EnvFromSource objects

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.

image

String

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

imagePullPolicy

String

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

lifecycle

io.k8s.api.core.v1.Lifecycle object

Lifecycle is not allowed for ephemeral containers.

livenessProbe

io.k8s.api.core.v1.Probe object

Probes are not allowed for ephemeral containers.

name

String

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

ports

Array of io.k8s.api.core.v1.ContainerPort objects

Ports are not allowed for ephemeral containers.

readinessProbe

io.k8s.api.core.v1.Probe object

Probes are not allowed for ephemeral containers.

resources

io.k8s.api.core.v1.ResourceRequirements object

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

securityContext

io.k8s.api.core.v1.SecurityContext object

SecurityContext is not allowed for ephemeral containers.

startupProbe

io.k8s.api.core.v1.Probe object

Probes are not allowed for ephemeral containers.

stdin

Boolean

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.

stdinOnce

Boolean

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

targetContainerName

String

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.

terminationMessagePath

String

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.

terminationMessagePolicy

String

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.

tty

Boolean

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

volumeDevices

Array of io.k8s.api.core.v1.VolumeDevice objects

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

volumeMounts

Array of io.k8s.api.core.v1.VolumeMount objects

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

workingDir

String

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.

表227 io.k8s.api.core.v1.HostAlias

参数

参数类型

描述

hostnames

Array of strings

Hostnames for the above IP address.

ip

String

IP address of the host file entry.

表228 io.k8s.api.core.v1.LocalObjectReference

参数

参数类型

描述

name

String

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

表229 io.k8s.api.core.v1.Container

参数

参数类型

描述

args

Array of strings

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

command

Array of strings

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

env

Array of io.k8s.api.core.v1.EnvVar objects

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

envFrom

Array of io.k8s.api.core.v1.EnvFromSource objects

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.

image

String

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.

imagePullPolicy

String

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

lifecycle

io.k8s.api.core.v1.Lifecycle object

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

livenessProbe

io.k8s.api.core.v1.Probe object

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

name

String

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

ports

Array of io.k8s.api.core.v1.ContainerPort objects

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.

readinessProbe

io.k8s.api.core.v1.Probe object

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

resources

io.k8s.api.core.v1.ResourceRequirements object

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

securityContext

io.k8s.api.core.v1.SecurityContext object

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/

startupProbe

io.k8s.api.core.v1.Probe object

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

stdin

Boolean

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.

stdinOnce

Boolean

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

terminationMessagePath

String

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.

terminationMessagePolicy

String

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.

tty

Boolean

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

volumeDevices

Array of io.k8s.api.core.v1.VolumeDevice objects

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

volumeMounts

Array of io.k8s.api.core.v1.VolumeMount objects

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

workingDir

String

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.

表230 io.k8s.api.core.v1.EnvVar

参数

参数类型

描述

name

String

Name of the environment variable. Must be a C_IDENTIFIER.

value

String

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

valueFrom

io.k8s.api.core.v1.EnvVarSource object

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

表231 io.k8s.api.core.v1.EnvVarSource

参数

参数类型

描述

configMapKeyRef

io.k8s.api.core.v1.ConfigMapKeySelector object

Selects a key of a ConfigMap.

fieldRef

io.k8s.api.core.v1.ObjectFieldSelector object

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

resourceFieldRef

io.k8s.api.core.v1.ResourceFieldSelector object

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.

secretKeyRef

io.k8s.api.core.v1.SecretKeySelector object

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

表232 io.k8s.api.core.v1.ConfigMapKeySelector

参数

参数类型

描述

key

String

The key to select.

name

String

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

optional

Boolean

Specify whether the ConfigMap or its key must be defined

表233 io.k8s.api.core.v1.SecretKeySelector

参数

参数类型

描述

key

String

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

name

String

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

optional

Boolean

Specify whether the Secret or its key must be defined

表234 io.k8s.api.core.v1.EnvFromSource

参数

参数类型

描述

configMapRef

io.k8s.api.core.v1.ConfigMapEnvSource object

The ConfigMap to select from

prefix

String

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

secretRef

io.k8s.api.core.v1.SecretEnvSource object

The Secret to select from

表235 io.k8s.api.core.v1.ConfigMapEnvSource

参数

参数类型

描述

name

String

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

optional

Boolean

Specify whether the ConfigMap must be defined

表236 io.k8s.api.core.v1.SecretEnvSource

参数

参数类型

描述

name

String

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

optional

Boolean

Specify whether the Secret must be defined

表237 io.k8s.api.core.v1.Lifecycle

参数

参数类型

描述

postStart

io.k8s.api.core.v1.Handler object

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

preStop

io.k8s.api.core.v1.Handler object

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

表238 io.k8s.api.core.v1.Handler

参数

参数类型

描述

exec

io.k8s.api.core.v1.ExecAction object

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

httpGet

io.k8s.api.core.v1.HTTPGetAction object

HTTPGet specifies the http request to perform.

tcpSocket

io.k8s.api.core.v1.TCPSocketAction object

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

表239 io.k8s.api.core.v1.ContainerPort

参数

参数类型

描述

containerPort

Integer

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

hostIP

String

What host IP to bind the external port to.

hostPort

Integer

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.

name

String

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.

protocol

String

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

表240 io.k8s.api.core.v1.SecurityContext

参数

参数类型

描述

allowPrivilegeEscalation

Boolean

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

capabilities

io.k8s.api.core.v1.Capabilities object

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

privileged

Boolean

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

procMount

String

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.

readOnlyRootFilesystem

Boolean

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

runAsGroup

Long

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.

runAsNonRoot

Boolean

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.

runAsUser

Long

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.

seLinuxOptions

io.k8s.api.core.v1.SELinuxOptions object

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.

seccompProfile

io.k8s.api.core.v1.SeccompProfile object

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.

windowsOptions

io.k8s.api.core.v1.WindowsSecurityContextOptions object

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.

表241 io.k8s.api.core.v1.Capabilities

参数

参数类型

描述

add

Array of strings

Added capabilities

drop

Array of strings

Removed capabilities

表242 io.k8s.api.core.v1.Probe

参数

参数类型

描述

exec

io.k8s.api.core.v1.ExecAction object

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

failureThreshold

Integer

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

httpGet

io.k8s.api.core.v1.HTTPGetAction object

HTTPGet specifies the http request to perform.

initialDelaySeconds

Integer

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

periodSeconds

Integer

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

successThreshold

Integer

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

tcpSocket

io.k8s.api.core.v1.TCPSocketAction object

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

timeoutSeconds

Integer

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

表243 io.k8s.api.core.v1.ExecAction

参数

参数类型

描述

command

Array of strings

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

表244 io.k8s.api.core.v1.HTTPGetAction

参数

参数类型

描述

host

String

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

httpHeaders

Array of io.k8s.api.core.v1.HTTPHeader objects

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

path

String

Path to access on the HTTP server.

port

String

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.

scheme

String

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

表245 io.k8s.api.core.v1.HTTPHeader

参数

参数类型

描述

name

String

The header field name

value

String

The header field value

表246 io.k8s.api.core.v1.TCPSocketAction

参数

参数类型

描述

host

String

Optional: Host name to connect to, defaults to the pod IP.

port

String

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.

表247 io.k8s.api.core.v1.VolumeDevice

参数

参数类型

描述

devicePath

String

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

name

String

name must match the name of a persistentVolumeClaim in the pod

表248 io.k8s.api.core.v1.VolumeMount

参数

参数类型

描述

extendPathMode

String

Extend the volume path by appending the pod metadata to the path according to specified pattern. which provide a way of directory isolation and help prevent the writing conflict between different pods.

mountPath

String

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

mountPropagation

String

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.

name

String

This must match the Name of a Volume.

policy

io.k8s.api.core.v1.Policy object

VolumeMount Policy.

readOnly

Boolean

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

subPath

String

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

subPathExpr

String

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.

表249 io.k8s.api.core.v1.Policy

参数

参数类型

描述

logs

io.k8s.api.core.v1.Logs object

Logs describes log Volume and its rotate strategy.

表250 io.k8s.api.core.v1.Logs

参数

参数类型

描述

annotations

Map<String,String>

Annotations for log.

rotate

String

Rotate strategy, including 'Daily' 'Hourly' 'Weekly'.

表251 io.k8s.api.core.v1.PodReadinessGate

参数

参数类型

描述

conditionType

String

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

表252 io.k8s.api.core.v1.PodSecurityContext

参数

参数类型

描述

fsGroup

Long

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.

fsGroupChangePolicy

String

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified defaults to "Always".

runAsGroup

Long

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.

runAsNonRoot

Boolean

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.

runAsUser

Long

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.

seLinuxOptions

io.k8s.api.core.v1.SELinuxOptions object

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.

seccompProfile

io.k8s.api.core.v1.SeccompProfile object

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

supplementalGroups

Array of longs

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.

sysctls

Array of io.k8s.api.core.v1.Sysctl objects

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

windowsOptions

io.k8s.api.core.v1.WindowsSecurityContextOptions object

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.

表253 io.k8s.api.core.v1.SELinuxOptions

参数

参数类型

描述

level

String

Level is SELinux level label that applies to the container.

role

String

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

type

String

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

user

String

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

表254 io.k8s.api.core.v1.SeccompProfile

参数

参数类型

描述

localhostProfile

String

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

type

String

type indicates which kind of seccomp profile will be applied. Valid options are:

Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.

表255 io.k8s.api.core.v1.Sysctl

参数

参数类型

描述

name

String

Name of a property to set

value

String

Value of a property to set

表256 io.k8s.api.core.v1.WindowsSecurityContextOptions

参数

参数类型

描述

gmsaCredentialSpec

String

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.

gmsaCredentialSpecName

String

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

runAsUserName

String

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.

表257 io.k8s.api.core.v1.Toleration

参数

参数类型

描述

effect

String

Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

key

String

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.

operator

String

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.

tolerationSeconds

Long

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.

value

String

Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

表258 io.k8s.api.core.v1.TopologySpreadConstraint

参数

参数类型

描述

labelSelector

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

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.

maxSkew

Integer

MaxSkew describes the degree to which pods may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When whenUnsatisfiable=ScheduleAnyway, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.

topologyKey

String

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

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.

表259 io.k8s.api.core.v1.Volume

参数

参数类型

awsElasticBlockStore

io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource object

azureDisk

io.k8s.api.core.v1.AzureDiskVolumeSource object

azureFile

io.k8s.api.core.v1.AzureFileVolumeSource object

cephfs

io.k8s.api.core.v1.CephFSVolumeSource object

cinder

io.k8s.api.core.v1.CinderVolumeSource object

configMap

io.k8s.api.core.v1.ConfigMapVolumeSource object

csi

io.k8s.api.core.v1.CSIVolumeSource object

downwardAPI

io.k8s.api.core.v1.DownwardAPIVolumeSource object

emptyDir

io.k8s.api.core.v1.EmptyDirVolumeSource object

ephemeral

io.k8s.api.core.v1.EphemeralVolumeSource object

fc

io.k8s.api.core.v1.FCVolumeSource object

flexVolume

io.k8s.api.core.v1.FlexVolumeSource object

flocker

io.k8s.api.core.v1.FlockerVolumeSource object

gcePersistentDisk

io.k8s.api.core.v1.GCEPersistentDiskVolumeSource object

gitRepo

io.k8s.api.core.v1.GitRepoVolumeSource object

glusterfs

io.k8s.api.core.v1.GlusterfsVolumeSource object

hostPath

io.k8s.api.core.v1.HostPathVolumeSource object

iscsi

io.k8s.api.core.v1.ISCSIVolumeSource object

localDir

io.k8s.api.core.v1.LocalDirVolumeSource object

name

String

nfs

io.k8s.api.core.v1.NFSVolumeSource object

persistentVolumeClaim

io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource object

photonPersistentDisk

io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource object

portworxVolume

io.k8s.api.core.v1.PortworxVolumeSource object

projected

io.k8s.api.core.v1.ProjectedVolumeSource object

quobyte

io.k8s.api.core.v1.QuobyteVolumeSource object

rbd

io.k8s.api.core.v1.RBDVolumeSource object

scaleIO

io.k8s.api.core.v1.ScaleIOVolumeSource object

secret

io.k8s.api.core.v1.SecretVolumeSource object

storageos

io.k8s.api.core.v1.StorageOSVolumeSource object

vsphereVolume

io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource object

表260 io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource

参数

参数类型

描述

fsType

String

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

partition

Integer

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

readOnly

Boolean

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

volumeID

String

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

表261 io.k8s.api.core.v1.AzureDiskVolumeSource

参数

参数类型

描述

cachingMode

String

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

diskName

String

The Name of the data disk in the blob storage

diskURI

String

The URI the data disk in the blob storage

fsType

String

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.

kind

String

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

readOnly

Boolean

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

表262 io.k8s.api.core.v1.AzureFileVolumeSource

参数

参数类型

描述

readOnly

Boolean

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

secretName

String

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

shareName

String

Share Name

表263 io.k8s.api.core.v1.CephFSVolumeSource

参数

参数类型

描述

monitors

Array of strings

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: Used as the mounted root, rather than the full Ceph tree, default is /

readOnly

Boolean

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

secretFile

String

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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

user

String

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

表264 io.k8s.api.core.v1.CinderVolumeSource

参数

参数类型

描述

fsType

String

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

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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

volumeID

String

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

表265 io.k8s.api.core.v1.ConfigMapVolumeSource

参数

参数类型

描述

defaultMode

Integer

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

items

Array of io.k8s.api.core.v1.KeyToPath objects

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

name

String

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

optional

Boolean

Specify whether the ConfigMap or its keys must be defined

表266 io.k8s.api.core.v1.CSIVolumeSource

参数

参数类型

描述

driver

String

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.

fsType

String

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.

nodePublishSecretRef

io.k8s.api.core.v1.LocalObjectReference object

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.

readOnly

Boolean

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

volumeAttributes

Map<String,String>

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

表267 io.k8s.api.core.v1.DownwardAPIVolumeSource

参数

参数类型

描述

defaultMode

Integer

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

items

Array of io.k8s.api.core.v1.DownwardAPIVolumeFile objects

Items is a list of downward API volume file

表268 io.k8s.api.core.v1.EmptyDirVolumeSource

参数

参数类型

描述

medium

String

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

sizeLimit

String

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

表269 io.k8s.api.core.v1.EphemeralVolumeSource

参数

参数类型

描述

readOnly

Boolean

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

volumeClaimTemplate

io.k8s.api.core.v1.PersistentVolumeClaimTemplate object

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

表270 io.k8s.api.core.v1.PersistentVolumeClaimTemplate

参数

参数类型

描述

metadata

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta object

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

spec

io.k8s.api.core.v1.PersistentVolumeClaimSpec object

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

表271 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

参数

参数类型

描述

annotations

Map<String,String>

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

clusterName

String

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

creationTimestamp

String

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds

Long

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

deletionTimestamp

String

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

finalizers

Array of strings

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

generateName

String

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

generation

Long

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

labels

Map<String,String>

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

managedFields

Array of io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry objects

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

name

String

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

namespace

String

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

ownerReferences

Array of io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference objects

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

resourceVersion

String

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

selfLink

String

SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

uid

String

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

表272 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

参数

参数类型

描述

apiVersion

String

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

fieldsType

String

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

fieldsV1

Object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

manager

String

Manager is an identifier of the workflow managing these fields.

operation

String

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

time

String

Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

表273 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

参数

参数类型

描述

apiVersion

String

API version of the referent.

blockOwnerDeletion

Boolean

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

controller

Boolean

If true, this reference points to the managing controller.

kind

String

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

name

String

Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

uid

String

UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

表274 io.k8s.api.core.v1.PersistentVolumeClaimSpec

参数

参数类型

描述

accessModes

Array of strings

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

dataSource

io.k8s.api.core.v1.TypedLocalObjectReference object

This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot - Beta) * An existing PVC (PersistentVolumeClaim) * An existing custom resource/object that implements data population (Alpha) In order to use VolumeSnapshot object types, the appropriate feature gate must be enabled (VolumeSnapshotDataSource or AnyVolumeDataSource) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the specified data source is not supported, the 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.

resources

io.k8s.api.core.v1.ResourceRequirements object

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

selector

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector object

A label query over volumes to consider for binding.

storageClassName

String

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

volumeMode

String

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

volumeName

String

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

表275 io.k8s.api.core.v1.TypedLocalObjectReference

参数

参数类型

描述

apiGroup

String

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.

kind

String

Kind is the type of resource being referenced

name

String

Name is the name of resource being referenced

表276 io.k8s.api.core.v1.ResourceRequirements

参数

参数类型

描述

limits

Map<String,String>

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

requests

Map<String,String>

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/

表277 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

参数

参数类型

描述

matchExpressions

Array of io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement objects

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

matchLabels

Map<String,String>

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

表278 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

参数

参数类型

描述

key

String

key is the label key that the selector applies to.

operator

String

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

values

Array of strings

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

表279 io.k8s.api.core.v1.FCVolumeSource

参数

参数类型

描述

fsType

String

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.

lun

Integer

Optional: FC target lun number

readOnly

Boolean

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

targetWWNs

Array of strings

Optional: FC target worldwide names (WWNs)

wwids

Array of strings

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

表280 io.k8s.api.core.v1.FlexVolumeSource

参数

参数类型

描述

driver

String

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

fsType

String

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.

options

Map<String,String>

Optional: Extra command options if any.

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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.

表281 io.k8s.api.core.v1.FlockerVolumeSource

参数

参数类型

描述

datasetName

String

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

datasetUUID

String

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

表282 io.k8s.api.core.v1.GCEPersistentDiskVolumeSource

参数

参数类型

描述

fsType

String

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

partition

Integer

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

pdName

String

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

readOnly

Boolean

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

表283 io.k8s.api.core.v1.GitRepoVolumeSource

参数

参数类型

描述

directory

String

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.

repository

String

Repository URL

revision

String

Commit hash for the specified revision.

表284 io.k8s.api.core.v1.GlusterfsVolumeSource

参数

参数类型

描述

endpoints

String

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

path

String

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

readOnly

Boolean

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

表285 io.k8s.api.core.v1.HostPathVolumeSource

参数

参数类型

描述

path

String

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

type

String

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

表286 io.k8s.api.core.v1.ISCSIVolumeSource

参数

参数类型

描述

chapAuthDiscovery

Boolean

whether support iSCSI Discovery CHAP authentication

chapAuthSession

Boolean

whether support iSCSI Session CHAP authentication

fsType

String

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

initiatorName

String

Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]:[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] will be created for the connection.

iqn

String

Target iSCSI Qualified Name.

iscsiInterface

String

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

lun

Integer

iSCSI Target Lun number.

portals

Array of strings

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

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

CHAP Secret for iSCSI target and initiator authentication

targetPortal

String

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

表287 io.k8s.api.core.v1.LocalDirVolumeSource

参数

参数类型

描述

sizeLimit

String

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.

The serialization format is:

[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] (Note that [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] may be empty, from the "" case in [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].) [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= 0 | 1 | ... | 9 [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br].[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]. | .[/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "+" | "-" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br][/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] ::= "e" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br] | "E" [/topic/body/section/table/tgroup/tbody/row/entry/p/br {""}) (br]

No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.

When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.

Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: a. No precision is lost b. No fractional digits will be emitted c. The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative.

Examples: 1.5 will be serialized as "1500m" 1.5Gi will be serialized as "1536Mi"

Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.

Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)

This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

表288 io.k8s.api.core.v1.NFSVolumeSource

参数

参数类型

描述

path

String

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

readOnly

Boolean

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

server

String

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

表289 io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource

参数

参数类型

描述

claimName

String

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

Boolean

Will force the ReadOnly setting in VolumeMounts. Default false.

表290 io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource

参数

参数类型

描述

fsType

String

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.

pdID

String

ID that identifies Photon Controller persistent disk

表291 io.k8s.api.core.v1.PortworxVolumeSource

参数

参数类型

描述

fsType

String

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

Boolean

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

volumeID

String

VolumeID uniquely identifies a Portworx volume

表292 io.k8s.api.core.v1.ProjectedVolumeSource

参数

参数类型

描述

defaultMode

Integer

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

sources

Array of io.k8s.api.core.v1.VolumeProjection objects

list of volume projections

表293 io.k8s.api.core.v1.VolumeProjection

参数

参数类型

描述

configMap

io.k8s.api.core.v1.ConfigMapProjection object

information about the configMap data to project

downwardAPI

io.k8s.api.core.v1.DownwardAPIProjection object

information about the downwardAPI data to project

secret

io.k8s.api.core.v1.SecretProjection object

information about the secret data to project

serviceAccountToken

io.k8s.api.core.v1.ServiceAccountTokenProjection object

information about the serviceAccountToken data to project

表294 io.k8s.api.core.v1.ConfigMapProjection

参数

参数类型

描述

items

Array of io.k8s.api.core.v1.KeyToPath objects

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

name

String

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

optional

Boolean

Specify whether the ConfigMap or its keys must be defined

表295 io.k8s.api.core.v1.DownwardAPIProjection

参数

参数类型

描述

items

Array of io.k8s.api.core.v1.DownwardAPIVolumeFile objects

Items is a list of DownwardAPIVolume file

表296 io.k8s.api.core.v1.DownwardAPIVolumeFile

参数

参数类型

描述

fieldRef

io.k8s.api.core.v1.ObjectFieldSelector object

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

mode

Integer

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

path

String

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

resourceFieldRef

io.k8s.api.core.v1.ResourceFieldSelector object

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

表297 io.k8s.api.core.v1.ObjectFieldSelector

参数

参数类型

描述

apiVersion

String

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

fieldPath

String

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

表298 io.k8s.api.core.v1.ResourceFieldSelector

参数

参数类型

描述

containerName

String

Container name: required for volumes, optional for env vars

divisor

String

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

resource

String

Required: resource to select

表299 io.k8s.api.core.v1.SecretProjection

参数

参数类型

描述

items

Array of io.k8s.api.core.v1.KeyToPath objects

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

name

String

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

optional

Boolean

Specify whether the Secret or its key must be defined

表300 io.k8s.api.core.v1.ServiceAccountTokenProjection

参数

参数类型

描述

audience

String

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.

expirationSeconds

Long

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.

path

String

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

表301 io.k8s.api.core.v1.QuobyteVolumeSource

参数

参数类型

描述

group

String

Group to map volume access to Default is no group

readOnly

Boolean

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

registry

String

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

tenant

String

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

user

String

User to map volume access to Defaults to serivceaccount user

volume

String

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

表302 io.k8s.api.core.v1.RBDVolumeSource

参数

参数类型

描述

fsType

String

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

image

String

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

keyring

String

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

monitors

Array of strings

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

pool

String

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

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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

user

String

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

表303 io.k8s.api.core.v1.ScaleIOVolumeSource

参数

参数类型

描述

fsType

String

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

gateway

String

The host address of the ScaleIO API Gateway.

protectionDomain

String

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

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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

sslEnabled

Boolean

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

storageMode

String

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

storagePool

String

The ScaleIO Storage Pool associated with the protection domain.

system

String

The name of the storage system as configured in ScaleIO.

volumeName

String

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

表304 io.k8s.api.core.v1.SecretVolumeSource

参数

参数类型

描述

defaultMode

Integer

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

items

Array of io.k8s.api.core.v1.KeyToPath objects

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

Boolean

Specify whether the Secret or its keys must be defined

secretName

String

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

表305 io.k8s.api.core.v1.KeyToPath

参数

参数类型

描述

key

String

The key to project.

mode

Integer

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

path

String

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

表306 io.k8s.api.core.v1.StorageOSVolumeSource

参数

参数类型

描述

fsType

String

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.

readOnly

Boolean

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

secretRef

io.k8s.api.core.v1.LocalObjectReference object

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

volumeName

String

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

volumeNamespace

String

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.

表307 io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource

参数

参数类型

描述

fsType

String

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.

storagePolicyID

String

Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

storagePolicyName

String

Storage Policy Based Management (SPBM) profile name.

volumePath

String

Path that identifies vSphere volume vmdk

表308 io.k8s.api.apps.v1.DeploymentStatus

参数

参数类型

描述

availableReplicas

Integer

Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.

collisionCount

Integer

Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.

conditions

Array of io.k8s.api.apps.v1.DeploymentCondition objects

Represents the latest available observations of a deployment's current state.

observedGeneration

Long

The generation observed by the deployment controller.

readyReplicas

Integer

Total number of ready pods targeted by this deployment.

replicas

Integer

Total number of non-terminated pods targeted by this deployment (their labels match the selector).

unavailableReplicas

Integer

Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.

updatedReplicas

Integer

Total number of non-terminated pods targeted by this deployment that have the desired template spec.

表309 io.k8s.api.apps.v1.DeploymentCondition

参数

参数类型

描述

lastTransitionTime

String

Last time the condition transitioned from one status to another.

lastUpdateTime

String

The last time this condition was updated.

message

String

A human readable message indicating details about the transition.

reason

String

The reason for the condition's last transition.

status

String

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

type

String

Type of deployment condition.

请求示例

将已创建Deployment中的 镜像 替换为“ ...:20202/cci/ redis :V1”。

{
  "apiVersion" : "apps/v1",
  "kind" : "Deployment",
  "metadata" : {
    "name" : "deployment-test"
  },
  "spec" : {
    "replicas" : 2,
    "selector" : {
      "matchLabels" : {
        "app" : "redis"
      }
    },
    "template" : {
      "metadata" : {
        "labels" : {
          "app" : "redis"
        }
      },
      "spec" : {
        "containers" : [ {
          "image" : "*.*.*.*:20202/cci/redis:V1",
          "name" : "container-0",
          "resources" : {
            "limits" : {
              "cpu" : "500m",
              "memory" : "1024Mi"
            },
            "requests" : {
              "cpu" : "500m",
              "memory" : "1024Mi"
            }
          }
        } ],
        "imagePullSecrets" : [ {
          "name" : "imagepull-secret"
        } ]
      }
    }
  }
}

响应示例

状态码: 200

OK

{
  "apiVersion" : "apps/v1",
  "kind" : "Deployment",
  "metadata" : {
    "creationTimestamp" : "2018-09-06T03:39:32Z",
    "generation" : 2,
    "labels" : {
      "app" : "redis"
    },
    "name" : "deployment-test",
    "namespace" : "namespace-test",
    "resourceVersion" : "5636210",
    "selfLink" : "/apis/apps/v1/namespaces/namespace-test/deployments/deployment-test",
    "uid" : "777dce52-b186-11e8-8cb0-c81fbe371a17"
  },
  "spec" : {
    "progressDeadlineSeconds" : 600,
    "replicas" : 2,
    "revisionHistoryLimit" : 10,
    "selector" : {
      "matchLabels" : {
        "app" : "redis"
      }
    },
    "strategy" : {
      "rollingUpdate" : {
        "maxSurge" : "25%",
        "maxUnavailable" : "25%"
      },
      "type" : "RollingUpdate"
    },
    "template" : {
      "metadata" : {
        "creationTimestamp" : null,
        "labels" : {
          "app" : "redis"
        }
      },
      "spec" : {
        "containers" : [ {
          "image" : "redis",
          "imagePullPolicy" : "IfNotPresent",
          "name" : "container-0",
          "resources" : {
            "limits" : {
              "cpu" : "500m",
              "memory" : "1Gi"
            },
            "requests" : {
              "cpu" : "500m",
              "memory" : "1Gi"
            }
          },
          "terminationMessagePath" : "/dev/termination-log",
          "terminationMessagePolicy" : "File"
        } ],
        "dnsPolicy" : "ClusterFirst",
        "imagePullSecrets" : [ {
          "name" : "imagepull-secret"
        } ],
        "restartPolicy" : "Always",
        "schedulerName" : "default-scheduler",
        "securityContext" : { }
      }
    }
  },
  "status" : {
    "availableReplicas" : 1,
    "conditions" : [ {
      "lastTransitionTime" : "2018-09-06T03:39:40Z",
      "lastUpdateTime" : "2018-09-06T03:39:40Z",
      "message" : "Deployment has minimum availability.",
      "reason" : "MinimumReplicasAvailable",
      "status" : "True",
      "type" : "Available"
    }, {
      "lastTransitionTime" : "2018-09-06T03:39:32Z",
      "lastUpdateTime" : "2018-09-06T03:39:40Z",
      "message" : "ReplicaSet \"deployment-test-865578b586\" has successfully\nprogressed.",
      "reason" : "NewReplicaSetAvailable",
      "status" : "True",
      "type" : "Progressing"
    } ],
    "observedGeneration" : 1,
    "readyReplicas" : 1,
    "replicas" : 1,
    "updatedReplicas" : 1
  }
}

状态码

状态码

描述

200

OK

201

Created

400

BadRequest

401

Unauthorized

403

Forbidden

404

NotFound

405

MethodNotAllowed

406

NotAcceptable

409

Conflict

415

UnsupportedMediaType

422

Invalid

429

TooManyRequests

500

InternalError

503

ServiceUnavailable

504

ServerTimeout

 

上一篇:如何给网站添加Banner轮播大图效果 下一篇:Zabbix是什么