.jpg)
.jpg)
.jpg)
.jpg)
功能介绍
更新Pod。
其中以下字段支持更新：
-
metadata.generateName
-
metadata.labels
-
metadata.annotations
-
spec.initContainers[*].image
-
spec.containers[*].image
-
spec.activeDeadlineSeconds
-
spec.tolerations 其余部分不支持更新。
调用方法
请参见如何调用API。
URI
PATCH /api/v1/namespaces/{namespace}/pods/{name}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
name of the Pod |
|
namespace |
是 |
String |
object name and auth scope, such as for teams and projects |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
|
force |
否 |
Boolean |
Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
|
pretty |
否 |
String |
If 'true', then the output is pretty printed. |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
Content-Type |
是 |
String |
目前支持三种类型的PATCH请求方法的操作，参考《使用JSON合并patch更新Deployment》。
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
- |
是 |
Object |
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body. |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
spec |
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 |
|
|
status |
Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
nodeAffinity |
Describes node affinity scheduling rules for the pod. |
|
|
podAffinity |
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). |
|
|
podAntiAffinity |
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
preferredDuringSchedulingIgnoredDuringExecution |
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 |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
preference |
A node selector term, associated with the corresponding weight. |
|
|
weight |
Integer |
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
matchExpressions |
A list of node selector requirements by node's labels. |
|
|
matchFields |
A list of node selector requirements by node's fields. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
nodeSelectorTerms |
Required. A list of node selector terms. The terms are ORed. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
preferredDuringSchedulingIgnoredDuringExecution |
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 |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
preferredDuringSchedulingIgnoredDuringExecution |
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 |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
podAffinityTerm |
Required. A pod affinity term, associated with the corresponding weight. |
|
|
weight |
Integer |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
labelSelector |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
Required. |
|
value |
String |
value is the value of the option |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
List of environment variables to set in the container. Cannot be updated. |
|
|
envFrom |
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 |
Lifecycle is not allowed for ephemeral containers. |
|
|
livenessProbe |
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 |
Ports are not allowed for ephemeral containers. |
|
|
readinessProbe |
Probes are not allowed for ephemeral containers. |
|
|
resources |
Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod. |
|
|
securityContext |
SecurityContext is not allowed for ephemeral containers. |
|
|
startupProbe |
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 |
volumeDevices is the list of block devices to be used by the container. |
|
|
volumeMounts |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
hostnames |
Array of strings |
Hostnames for the above IP address. |
|
ip |
String |
IP address of the host file entry. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
List of environment variables to set in the container. Cannot be updated. |
|
|
envFrom |
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 |
Actions that the management system should take in response to container lifecycle events. Cannot be updated. |
|
|
livenessProbe |
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 |
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 |
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 |
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
|
|
securityContext |
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 |
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 |
volumeDevices is the list of block devices to be used by the container. |
|
|
volumeMounts |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
Source for the environment variable's value. Cannot be used if value is not empty. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
configMapKeyRef |
Selects a key of a ConfigMap. |
|
|
fieldRef |
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 |
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 |
Selects a key of a secret in the pod's namespace |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
configMapRef |
The ConfigMap to select from |
|
|
prefix |
String |
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. |
|
secretRef |
The Secret to select from |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
postStart |
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 |
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
exec |
One and only one of the following should be specified. Exec specifies the action to take. |
|
|
httpGet |
HTTPGet specifies the http request to perform. |
|
|
tcpSocket |
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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". |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
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 |
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 |
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 |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
add |
Array of strings |
Added capabilities |
|
drop |
Array of strings |
Removed capabilities |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
exec |
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 |
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 |
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
host |
String |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
httpHeaders |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
The header field name |
|
value |
String |
The header field value |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
annotations |
Map<String,String> |
Annotations for log. |
|
rotate |
String |
Rotate strategy, including 'Daily' 'Hourly' 'Weekly'. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
conditionType |
String |
ConditionType refers to a condition in the pod's condition list with matching type. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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:
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 |
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 |
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 |
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. |
|
|
windowsOptions |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
Name of a property to set |
|
value |
String |
Value of a property to set |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
labelSelector |
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. |
|
参数 |
参数类型 |
|---|---|
|
awsElasticBlockStore |
|
|
azureDisk |
|
|
azureFile |
|
|
cephfs |
|
|
cinder |
|
|
configMap |
|
|
csi |
|
|
downwardAPI |
|
|
emptyDir |
|
|
ephemeral |
|
|
fc |
|
|
flexVolume |
|
|
flocker |
|
|
gcePersistentDisk |
|
|
gitRepo |
|
|
glusterfs |
|
|
hostPath |
|
|
iscsi |
|
|
localDir |
|
|
name |
String |
|
nfs |
|
|
persistentVolumeClaim |
|
|
photonPersistentDisk |
|
|
portworxVolume |
|
|
projected |
|
|
quobyte |
|
|
rbd |
|
|
scaleIO |
|
|
secret |
|
|
storageos |
|
|
vsphereVolume |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
Items is a list of downward API volume file |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
readOnly |
Boolean |
Specifies a read-only configuration for the volume. Defaults to false (read/write). |
|
volumeClaimTemplate |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
metadata |
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 |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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' |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
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 |
Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
|
|
selector |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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/ |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
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). |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
list of volume projections |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
configMap |
information about the configMap data to project |
|
|
downwardAPI |
information about the downwardAPI data to project |
|
|
secret |
information about the secret data to project |
|
|
serviceAccountToken |
information about the serviceAccountToken data to project |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
items |
If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
items |
Items is a list of DownwardAPIVolume file |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
fieldRef |
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 |
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
items |
If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 '..'. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
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. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
conditions |
Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions |
|
|
containerStatuses |
The list has one entry per container in the manifest. Each entry is currently the output of docker inspect. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status |
|
|
ephemeralContainerStatuses |
Status for any ephemeral containers that have run in this pod. This field is alpha-level and is only populated by servers that enable the EphemeralContainers feature. |
|
|
hostIP |
String |
IP address of the host to which the pod is assigned. Empty if not yet scheduled. |
|
initContainerStatuses |
The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status |
|
|
message |
String |
A human readable message indicating details about why the pod is in this condition. |
|
nominatedNodeName |
String |
nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled. |
|
phase |
String |
The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values: Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase |
|
podIP |
String |
IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated. |
|
podIPs |
podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet. |
|
|
qosClass |
String |
The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md |
|
reason |
String |
A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted' |
|
startTime |
String |
RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
lastProbeTime |
String |
Last time we probed the condition. |
|
lastTransitionTime |
String |
Last time the condition transitioned from one status to another. |
|
message |
String |
Human-readable message indicating details about last transition. |
|
reason |
String |
Unique, one-word, CamelCase reason for the condition's last transition. |
|
status |
String |
Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions |
|
type |
String |
Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
containerID |
String |
Container's ID in the format 'docker://<container_id>'. |
|
image |
String |
The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images |
|
imageID |
String |
ImageID of the container's image. |
|
lastState |
Details about the container's last termination condition. |
|
|
name |
String |
This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. |
|
ready |
Boolean |
Specifies whether the container has passed its readiness probe. |
|
restartCount |
Integer |
The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. |
|
started |
Boolean |
Specifies whether the container has passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. Is always true when no startupProbe is defined. |
|
state |
Details about the container's current condition. |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
running |
Details about a running container |
|
|
terminated |
Details about a terminated container |
|
|
waiting |
Details about a waiting container |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
startedAt |
String |
Time at which the container was last (re-)started |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
containerID |
String |
Container's ID in the format 'docker://<container_id>' |
|
exitCode |
Integer |
Exit status from the last termination of the container |
|
finishedAt |
String |
Time at which the container last terminated |
|
message |
String |
Message regarding the last termination of the container |
|
reason |
String |
(brief) reason from the last termination of the container |
|
signal |
Integer |
Signal from the last termination of the container |
|
startedAt |
String |
Time at which previous execution of the container started |
请求示例
将Pod的labels值更新为pod-test2。
{
"metadata" : {
"labels" : {
"name" : "pod-test2"
}
}
}
响应示例
状态码： 200
OK
{ "apiVersion" : "v1", "kind" : "Pod", "metadata" : { "annotations" : { "kubernetes.io/availablezone" : "dc1", "network.alpha.kubernetes.io/network" : "[{\"name\":\"namespace-test-dc1-default-network\"
,\"interface
\":\"eth0\",\"network_plane\"
:\"default\"}]" }, "creationTimestamp" : "2018-09-04T11:04:02Z", "labels" : { "name" : "pod-test2" }, "name" : "pod-test", "namespace" : "namespace-test", "resourceVersion" : "5254098", "selfLink" : "/api/v1/namespaces/namespace-test/pods/pod-test", "uid" : "3b99abe8-b032-11e8-9d5d-c88d83be759f" }, "spec" : { "containers" : [ { "image" : "redis:latest", "imagePullPolicy" : "Always", "name" : "test", "resources" : { "limits" : { "cpu" : "500m", "memory" : "1Gi" }, "requests" : { "cpu" : "500m", "memory" : "1Gi" } }, "terminationMessagePath" : "/dev/termination-log", "terminationMessagePolicy" : "File" } ], "dnsPolicy" : "ClusterFirst", "imagePullSecrets" : [ { "name" : "imagepull-secret" } ], "nodeName" : "c0dd6256-195a-e811-90a2-10c17294fcbc", "restartPolicy" : "Always", "schedulerName" : "default-scheduler", "securityContext" : { }, "tolerations" : [ { "effect" : "NoExecute", "key" : "node.kubernetes.io/not-ready", "operator" : "Exists", "tolerationSeconds" : 300 }, { "effect" : "NoExecute", "key" : "node.kubernetes.io/unreachable", "operator" : "Exists", "tolerationSeconds" : 300 } ] }, "status" : { "conditions" : [ { "lastProbeTime" : null, "lastTransitionTime" : "2018-09-04T11:04:03Z", "status" : "True", "type" : "Initialized" }, { "lastProbeTime" : null, "lastTransitionTime" : "2018-09-04T11:08:55Z", "message" : "containers with unready status: [test]", "reason" : "ContainersNotReady", "status" : "False", "type" : "Ready" }, { "lastProbeTime" : null, "lastTransitionTime" : "2018-09-04T11:04:02Z", "status" : "True", "type" : "PodScheduled" } ], "containerStatuses" : [ { "image" : "redis:latest", "imageID" : "", "lastState" : { "terminated" : { "containerID" : "docker://f867ab7d5c68a86fc695e4d3e5f1912fdb8f98f5029ca96032b4d5d407d9a75c", "exitCode" : 0, "finishedAt" : "2018-09-04T11:08:33Z", "reason" : "Completed", "startedAt" : "2018-09-04T11:04:23Z" } }, "name" : "test", "ready" : false, "restartCount" : 0, "state" : { "waiting" : { "message" : "rpc error: code = Unknown desc = Error response from daemon: Get https://registry-1.docker.io/v2/: net/http: request canceled
while waiting for connection (Client.Timeout exceeded while awaiting headers)", "reason" : "ErrImagePull" } } } ], "hostIP" : "xxx.xxx.xxx.xxx", "phase" : "Running", "qosClass" : "Guaranteed", "startTime" : "2018-09-04T11:04:03Z" } }
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
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 |
