kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Omit API reference updates for v1.21 

Omitting this merge to make it easier to merge in from primary branch
and back in to the same primary branch.
This commit is contained in:
Tim Bannister 2021-04-06 19:39:36 +01:00
parent dfaf833582
commit 8dbf6671db
73 changed files with 5109 additions and 5299 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
content/en/docs/reference/kubernetes-api/authorization-resources/self-subject-rules-review-v1.md
View File

@ -51,13 +51,13 @@ SelfSubjectRulesReview enumerates the set of actions the current user can perfor
<a name="NonResourceRule"></a>
*NonResourceRule holds information that describes a rule for the non-resource*
- **status.nonResourceRules.verbs** ([]string), required
- **status.nonResourceRules.verbs** ([]string), required
Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.
Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.
- **status.nonResourceRules.nonResourceURLs** ([]string)
- **status.nonResourceRules.nonResourceURLs** ([]string)
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path. "*" means all.
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path. "*" means all.
- **status.resourceRules** ([]ResourceRule), required
@ -66,22 +66,22 @@ SelfSubjectRulesReview enumerates the set of actions the current user can perfor
<a name="ResourceRule"></a>
*ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.*
- **status.resourceRules.verbs** ([]string), required
- **status.resourceRules.verbs** ([]string), required
Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.
Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.
- **status.resourceRules.apiGroups** ([]string)
- **status.resourceRules.apiGroups** ([]string)
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
- **status.resourceRules.resourceNames** ([]string)
- **status.resourceRules.resourceNames** ([]string)
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
- **status.resourceRules.resources** ([]string)
- **status.resourceRules.resources** ([]string)
Resources is a list of resources this rule applies to. "*" means all in the specified apiGroups.
"*/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
Resources is a list of resources this rule applies to. "*" means all in the specified apiGroups.
"*/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
- **status.evaluationError** (string)

7
content/en/docs/reference/kubernetes-api/cluster-resources/event-v1.md
View File

@ -26,10 +26,6 @@ Event is a report of an event somewhere in the cluster. It generally denotes som
- **kind**: Event
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **eventTime** (MicroTime), required
eventTime is the time when this Event was first observed. It is required.
@ -37,6 +33,9 @@ Event is a report of an event somewhere in the cluster. It generally denotes som
<a name="MicroTime"></a>
*MicroTime is version of Time with microsecond level precision.*
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>), required
- **action** (string)
action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters.

102
content/en/docs/reference/kubernetes-api/cluster-resources/flow-schema-v1beta1.md
View File

@ -92,43 +92,43 @@ FlowSchemaSpec describes how the FlowSchema's specification looks like.
<a name="Subject"></a>
*Subject matches the originator of a request, as identified by the request authentication system. There are three ways of matching an originator; by user, group, or service account.*
- **rules.subjects.kind** (string), required
- **rules.subjects.kind** (string), required
Required
Required
- **rules.subjects.group** (GroupSubject)
- **rules.subjects.group** (GroupSubject)
<a name="GroupSubject"></a>
*GroupSubject holds detailed information for group-kind subject.*
<a name="GroupSubject"></a>
*GroupSubject holds detailed information for group-kind subject.*
- **rules.subjects.group.name** (string), required
- **rules.subjects.group.name** (string), required
name is the user group that matches, or "*" to match all user groups. See https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go for some well-known group names. Required.
name is the user group that matches, or "*" to match all user groups. See https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go for some well-known group names. Required.
- **rules.subjects.serviceAccount** (ServiceAccountSubject)
- **rules.subjects.serviceAccount** (ServiceAccountSubject)
<a name="ServiceAccountSubject"></a>
*ServiceAccountSubject holds detailed information for service-account-kind subject.*
<a name="ServiceAccountSubject"></a>
*ServiceAccountSubject holds detailed information for service-account-kind subject.*
- **rules.subjects.serviceAccount.name** (string), required
- **rules.subjects.serviceAccount.name** (string), required
`name` is the name of matching ServiceAccount objects, or "*" to match regardless of name. Required.
`name` is the name of matching ServiceAccount objects, or "*" to match regardless of name. Required.
- **rules.subjects.serviceAccount.namespace** (string), required
- **rules.subjects.serviceAccount.namespace** (string), required
`namespace` is the namespace of matching ServiceAccount objects. Required.
`namespace` is the namespace of matching ServiceAccount objects. Required.
- **rules.subjects.user** (UserSubject)
- **rules.subjects.user** (UserSubject)
<a name="UserSubject"></a>
*UserSubject holds detailed information for user-kind subject.*
<a name="UserSubject"></a>
*UserSubject holds detailed information for user-kind subject.*
- **rules.subjects.user.name** (string), required
- **rules.subjects.user.name** (string), required
`name` is the username that matches, or "*" to match all usernames. Required.
`name` is the username that matches, or "*" to match all usernames. Required.
- **rules.nonResourceRules** ([]NonResourcePolicyRule)
@ -139,23 +139,23 @@ FlowSchemaSpec describes how the FlowSchema's specification looks like.
<a name="NonResourcePolicyRule"></a>
*NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request.*
- **rules.nonResourceRules.nonResourceURLs** ([]string), required
- **rules.nonResourceRules.nonResourceURLs** ([]string), required
*Set: unique values will be kept during a merge*
`nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example:
- "/healthz" is legal
- "/hea*" is illegal
- "/hea" is legal but matches nothing
- "/hea/*" also matches nothing
- "/healthz/*" matches all per-component health checks.
"*" matches all non-resource urls. if it is present, it must be the only entry. Required.
*Set: unique values will be kept during a merge*
`nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example:
- "/healthz" is legal
- "/hea*" is illegal
- "/hea" is legal but matches nothing
- "/hea/*" also matches nothing
- "/healthz/*" matches all per-component health checks.
"*" matches all non-resource urls. if it is present, it must be the only entry. Required.
- **rules.nonResourceRules.verbs** ([]string), required
- **rules.nonResourceRules.verbs** ([]string), required
*Set: unique values will be kept during a merge*
`verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required.
*Set: unique values will be kept during a merge*
`verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required.
- **rules.resourceRules** ([]ResourcePolicyRule)
@ -166,33 +166,33 @@ FlowSchemaSpec describes how the FlowSchema's specification looks like.
<a name="ResourcePolicyRule"></a>
*ResourcePolicyRule is a predicate that matches some resource requests, testing the request's verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) least one member of namespaces matches the request.*
- **rules.resourceRules.apiGroups** ([]string), required
- **rules.resourceRules.apiGroups** ([]string), required
*Set: unique values will be kept during a merge*
`apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required.
*Set: unique values will be kept during a merge*
`apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required.
- **rules.resourceRules.resources** ([]string), required
- **rules.resourceRules.resources** ([]string), required
*Set: unique values will be kept during a merge*
`resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required.
*Set: unique values will be kept during a merge*
`resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required.
- **rules.resourceRules.verbs** ([]string), required
- **rules.resourceRules.verbs** ([]string), required
*Set: unique values will be kept during a merge*
`verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required.
*Set: unique values will be kept during a merge*
`verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required.
- **rules.resourceRules.clusterScope** (boolean)
- **rules.resourceRules.clusterScope** (boolean)
`clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list.
`clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list.
- **rules.resourceRules.namespaces** ([]string)
- **rules.resourceRules.namespaces** ([]string)
*Set: unique values will be kept during a merge*
`namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true.
*Set: unique values will be kept during a merge*
`namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true.

108
content/en/docs/reference/kubernetes-api/cluster-resources/node-v1.md
View File

@ -62,25 +62,25 @@ NodeSpec describes the attributes that a node is created with.
<a name="ConfigMapNodeConfigSource"></a>
*ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.*
- **configSource.configMap.kubeletConfigKey** (string), required
- **configSource.configMap.kubeletConfigKey** (string), required
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
- **configSource.configMap.name** (string), required
- **configSource.configMap.name** (string), required
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
- **configSource.configMap.namespace** (string), required
- **configSource.configMap.namespace** (string), required
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
- **configSource.configMap.resourceVersion** (string)
- **configSource.configMap.resourceVersion** (string)
ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
- **configSource.configMap.uid** (string)
- **configSource.configMap.uid** (string)
UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
- **externalID** (string)
@ -216,32 +216,32 @@ NodeStatus is information about the current status of a node.
<a name="NodeConfigSource"></a>
*NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.*
- **config.active.configMap** (ConfigMapNodeConfigSource)
- **config.active.configMap** (ConfigMapNodeConfigSource)
ConfigMap is a reference to a Node's ConfigMap
ConfigMap is a reference to a Node's ConfigMap
<a name="ConfigMapNodeConfigSource"></a>
*ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.*
<a name="ConfigMapNodeConfigSource"></a>
*ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.*
- **config.active.configMap.kubeletConfigKey** (string), required
- **config.active.configMap.kubeletConfigKey** (string), required
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
- **config.active.configMap.name** (string), required
- **config.active.configMap.name** (string), required
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
- **config.active.configMap.namespace** (string), required
- **config.active.configMap.namespace** (string), required
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
- **config.active.configMap.resourceVersion** (string)
- **config.active.configMap.resourceVersion** (string)
ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
- **config.active.configMap.uid** (string)
- **config.active.configMap.uid** (string)
UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
- **config.assigned** (NodeConfigSource)
@ -250,32 +250,32 @@ NodeStatus is information about the current status of a node.
<a name="NodeConfigSource"></a>
*NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.*
- **config.assigned.configMap** (ConfigMapNodeConfigSource)
- **config.assigned.configMap** (ConfigMapNodeConfigSource)
ConfigMap is a reference to a Node's ConfigMap
ConfigMap is a reference to a Node's ConfigMap
<a name="ConfigMapNodeConfigSource"></a>
*ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.*
<a name="ConfigMapNodeConfigSource"></a>
*ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.*
- **config.assigned.configMap.kubeletConfigKey** (string), required
- **config.assigned.configMap.kubeletConfigKey** (string), required
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
- **config.assigned.configMap.name** (string), required
- **config.assigned.configMap.name** (string), required
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
- **config.assigned.configMap.namespace** (string), required
- **config.assigned.configMap.namespace** (string), required
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
- **config.assigned.configMap.resourceVersion** (string)
- **config.assigned.configMap.resourceVersion** (string)
ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
- **config.assigned.configMap.uid** (string)
- **config.assigned.configMap.uid** (string)
UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
- **config.error** (string)
@ -288,32 +288,32 @@ NodeStatus is information about the current status of a node.
<a name="NodeConfigSource"></a>
*NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.*
- **config.lastKnownGood.configMap** (ConfigMapNodeConfigSource)
- **config.lastKnownGood.configMap** (ConfigMapNodeConfigSource)
ConfigMap is a reference to a Node's ConfigMap
ConfigMap is a reference to a Node's ConfigMap
<a name="ConfigMapNodeConfigSource"></a>
*ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.*
<a name="ConfigMapNodeConfigSource"></a>
*ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.*
- **config.lastKnownGood.configMap.kubeletConfigKey** (string), required
- **config.lastKnownGood.configMap.kubeletConfigKey** (string), required
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
- **config.lastKnownGood.configMap.name** (string), required
- **config.lastKnownGood.configMap.name** (string), required
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
- **config.lastKnownGood.configMap.namespace** (string), required
- **config.lastKnownGood.configMap.namespace** (string), required
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
- **config.lastKnownGood.configMap.resourceVersion** (string)
- **config.lastKnownGood.configMap.resourceVersion** (string)
ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
- **config.lastKnownGood.configMap.uid** (string)
- **config.lastKnownGood.configMap.uid** (string)
UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
- **daemonEndpoints** (NodeDaemonEndpoints)
@ -329,9 +329,9 @@ NodeStatus is information about the current status of a node.
<a name="DaemonEndpoint"></a>
*DaemonEndpoint contains information about a single Daemon endpoint.*
- **daemonEndpoints.kubeletEndpoint.Port** (int32), required
- **daemonEndpoints.kubeletEndpoint.Port** (int32), required
Port number of the given endpoint.
Port number of the given endpoint.
- **images** ([]ContainerImage)

24
content/en/docs/reference/kubernetes-api/cluster-resources/priority-level-configuration-v1beta1.md
View File

@ -76,28 +76,28 @@ PriorityLevelConfigurationSpec specifies the configuration of a priority level.
<a name="LimitResponse"></a>
*LimitResponse defines how to handle requests that can not be executed right now.*
- **limited.limitResponse.type** (string), required
- **limited.limitResponse.type** (string), required
`type` is "Queue" or "Reject". "Queue" means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached. "Reject" means that requests that can not be executed upon arrival are rejected. Required.
`type` is "Queue" or "Reject". "Queue" means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached. "Reject" means that requests that can not be executed upon arrival are rejected. Required.
- **limited.limitResponse.queuing** (QueuingConfiguration)
- **limited.limitResponse.queuing** (QueuingConfiguration)
`queuing` holds the configuration parameters for queuing. This field may be non-empty only if `type` is `"Queue"`.
`queuing` holds the configuration parameters for queuing. This field may be non-empty only if `type` is `"Queue"`.
<a name="QueuingConfiguration"></a>
*QueuingConfiguration holds the configuration parameters for queuing*
<a name="QueuingConfiguration"></a>
*QueuingConfiguration holds the configuration parameters for queuing*
- **limited.limitResponse.queuing.handSize** (int32)
- **limited.limitResponse.queuing.handSize** (int32)
`handSize` is a small positive number that configures the shuffle sharding of requests into queues. When enqueuing a request at this priority level the request's flow identifier (a string pair) is hashed and the hash value is used to shuffle the list of queues and deal a hand of the size specified here. The request is put into one of the shortest queues in that hand. `handSize` must be no larger than `queues`, and should be significantly smaller (so that a few heavy flows do not saturate most of the queues). See the user-facing documentation for more extensive guidance on setting this field. This field has a default value of 8.
`handSize` is a small positive number that configures the shuffle sharding of requests into queues. When enqueuing a request at this priority level the request's flow identifier (a string pair) is hashed and the hash value is used to shuffle the list of queues and deal a hand of the size specified here. The request is put into one of the shortest queues in that hand. `handSize` must be no larger than `queues`, and should be significantly smaller (so that a few heavy flows do not saturate most of the queues). See the user-facing documentation for more extensive guidance on setting this field. This field has a default value of 8.
- **limited.limitResponse.queuing.queueLengthLimit** (int32)
- **limited.limitResponse.queuing.queueLengthLimit** (int32)
`queueLengthLimit` is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; excess requests are rejected. This value must be positive. If not specified, it will be defaulted to 50.
`queueLengthLimit` is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; excess requests are rejected. This value must be positive. If not specified, it will be defaulted to 50.
- **limited.limitResponse.queuing.queues** (int32)
- **limited.limitResponse.queuing.queues** (int32)
`queues` is the number of queues for this priority level. The queues exist independently at each apiserver. The value must be positive. Setting it to 1 effectively precludes shufflesharding and thus makes the distinguisher method of associated flow schemas irrelevant. This field has a default value of 64.
`queues` is the number of queues for this priority level. The queues exist independently at each apiserver. The value must be positive. Setting it to 1 effectively precludes shufflesharding and thus makes the distinguisher method of associated flow schemas irrelevant. This field has a default value of 64.

20
content/en/docs/reference/kubernetes-api/cluster-resources/runtime-class-v1.md
View File

@ -67,25 +67,25 @@ RuntimeClass defines a class of container runtime supported in the cluster. The
<a name="Toleration"></a>
*The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.*
- **scheduling.tolerations.key** (string)
- **scheduling.tolerations.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.
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.
- **scheduling.tolerations.operator** (string)
- **scheduling.tolerations.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.
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.
- **scheduling.tolerations.value** (string)
- **scheduling.tolerations.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.
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
- **scheduling.tolerations.effect** (string)
- **scheduling.tolerations.effect** (string)
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
- **scheduling.tolerations.tolerationSeconds** (int64)
- **scheduling.tolerations.tolerationSeconds** (int64)
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.
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.

40
content/en/docs/reference/kubernetes-api/common-definitions/downward-api-volume-file.md Normal file
View File

@ -0,0 +1,40 @@
---
api_metadata:
apiVersion: ""
import: "k8s.io/api/core/v1"
kind: "DownwardAPIVolumeFile"
content_type: "api_reference"
description: "DownwardAPIVolumeFile represents information to create the file containing the pod field."
title: "DownwardAPIVolumeFile"
weight: 2
---
`import "k8s.io/api/core/v1"`
DownwardAPIVolumeFile represents information to create the file containing the pod field
<hr>
- **path** (string), required
Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
- **fieldRef** (<a href="{{< ref "../common-definitions/object-field-selector#ObjectFieldSelector" >}}">ObjectFieldSelector</a>)
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
- **mode** (int32)
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.
- **resourceFieldRef** (<a href="{{< ref "../common-definitions/resource-field-selector#ResourceFieldSelector" >}}">ResourceFieldSelector</a>)
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

28
content/en/docs/reference/kubernetes-api/common-definitions/exec-action.md Normal file
View File

@ -0,0 +1,28 @@
---
api_metadata:
apiVersion: ""
import: "k8s.io/api/core/v1"
kind: "ExecAction"
content_type: "api_reference"
description: "ExecAction describes a \"run in container\" action."
title: "ExecAction"
weight: 3
---
`import "k8s.io/api/core/v1"`
ExecAction describes a "run in container" action.
<hr>
- **command** ([]string)
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.

58
content/en/docs/reference/kubernetes-api/common-definitions/http-get-action.md Normal file
View File

@ -0,0 +1,58 @@
---
api_metadata:
apiVersion: ""
import: "k8s.io/api/core/v1"
kind: "HTTPGetAction"
content_type: "api_reference"
description: "HTTPGetAction describes an action based on HTTP Get requests."
title: "HTTPGetAction"
weight: 4
---
`import "k8s.io/api/core/v1"`
HTTPGetAction describes an action based on HTTP Get requests.
<hr>
- **port** (IntOrString), required
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.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **host** (string)
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
- **httpHeaders** ([]HTTPHeader)
Custom headers to set in the request. HTTP allows repeated headers.
<a name="HTTPHeader"></a>
*HTTPHeader describes a custom header to be used in HTTP probes*
- **httpHeaders.name** (string), required
The header field name
- **httpHeaders.value** (string), required
The header field value
- **path** (string)
Path to access on the HTTP server.
- **scheme** (string)
Scheme to use for connecting to the host. Defaults to HTTP.

226
content/en/docs/reference/kubernetes-api/common-definitions/json-schema-props.md Normal file
View File

@ -0,0 +1,226 @@
---
api_metadata:
apiVersion: ""
import: "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
kind: "JSONSchemaProps"
content_type: "api_reference"
description: "JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema."
title: "JSONSchemaProps"
weight: 5
---
`import "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"`
JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).
<hr>
- **$ref** (string)
- **$schema** (string)
- **additionalItems** (JSONSchemaPropsOrBool)
<a name="JSONSchemaPropsOrBool"></a>
*JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.*
- **additionalProperties** (JSONSchemaPropsOrBool)
<a name="JSONSchemaPropsOrBool"></a>
*JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.*
- **allOf** ([]<a href="{{< ref "../common-definitions/json-schema-props#JSONSchemaProps" >}}">JSONSchemaProps</a>)
- **anyOf** ([]<a href="{{< ref "../common-definitions/json-schema-props#JSONSchemaProps" >}}">JSONSchemaProps</a>)
- **default** (JSON)
default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false.
<a name="JSON"></a>
*JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.*
- **definitions** (map[string]<a href="{{< ref "../common-definitions/json-schema-props#JSONSchemaProps" >}}">JSONSchemaProps</a>)
- **dependencies** (map[string]JSONSchemaPropsOrStringArray)
<a name="JSONSchemaPropsOrStringArray"></a>
*JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array.*
- **description** (string)
- **enum** ([]JSON)
<a name="JSON"></a>
*JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.*
- **example** (JSON)
<a name="JSON"></a>
*JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.*
- **exclusiveMaximum** (boolean)
- **exclusiveMinimum** (boolean)
- **externalDocs** (ExternalDocumentation)
<a name="ExternalDocumentation"></a>
*ExternalDocumentation allows referencing an external resource for extended documentation.*
- **externalDocs.description** (string)
- **externalDocs.url** (string)
- **format** (string)
format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
- bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
- **id** (string)
- **items** (JSONSchemaPropsOrArray)
<a name="JSONSchemaPropsOrArray"></a>
*JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.*
- **maxItems** (int64)
- **maxLength** (int64)
- **maxProperties** (int64)
- **maximum** (double)
- **minItems** (int64)
- **minLength** (int64)
- **minProperties** (int64)
- **minimum** (double)
- **multipleOf** (double)
- **not** (<a href="{{< ref "../common-definitions/json-schema-props#JSONSchemaProps" >}}">JSONSchemaProps</a>)
- **nullable** (boolean)
- **oneOf** ([]<a href="{{< ref "../common-definitions/json-schema-props#JSONSchemaProps" >}}">JSONSchemaProps</a>)
- **pattern** (string)
- **patternProperties** (map[string]<a href="{{< ref "../common-definitions/json-schema-props#JSONSchemaProps" >}}">JSONSchemaProps</a>)
- **properties** (map[string]<a href="{{< ref "../common-definitions/json-schema-props#JSONSchemaProps" >}}">JSONSchemaProps</a>)
- **required** ([]string)
- **title** (string)
- **type** (string)
- **uniqueItems** (boolean)
- **x-kubernetes-embedded-resource** (boolean)
x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata).
- **x-kubernetes-int-or-string** (boolean)
x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns:
1) anyOf:
- type: integer
- type: string
2) allOf:
- anyOf:
- type: integer
- type: string
- ... zero or more
- **x-kubernetes-list-map-keys** ([]string)
x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map.
This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported).
The properties specified must either be required or have a default value, to ensure those properties are present for all list items.
- **x-kubernetes-list-type** (string)
x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values:
1) `atomic`: the list is treated as a single entity, like a scalar.
Atomic lists will be entirely replaced when updated. This extension
may be used on any type of list (struct, scalar, ...).
2) `set`:
Sets are lists that must not have multiple items with the same value. Each
value must be a scalar, an object with x-kubernetes-map-type `atomic` or an
array with x-kubernetes-list-type `atomic`.
3) `map`:
These lists are like maps in that their elements have a non-index key
used to identify them. Order is preserved upon merge. The map tag
must only be used on a list with elements of type object.
Defaults to atomic for arrays.
- **x-kubernetes-map-type** (string)
x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values:
1) `granular`:
These maps are actual maps (key-value pairs) and each fields are independent
from each other (they can each be manipulated by separate actors). This is
the default behaviour for all maps.
2) `atomic`: the list is treated as a single entity, like a scalar.
Atomic maps will be entirely replaced when updated.
- **x-kubernetes-preserve-unknown-fields** (boolean)
x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden.

36
content/en/docs/reference/kubernetes-api/common-definitions/key-to-path.md Normal file
View File

@ -0,0 +1,36 @@
---
api_metadata:
apiVersion: ""
import: "k8s.io/api/core/v1"
kind: "KeyToPath"
content_type: "api_reference"
description: "Maps a string key to a path within a volume."
title: "KeyToPath"
weight: 6
---
`import "k8s.io/api/core/v1"`
Maps a string key to a path within a volume.
<hr>
- **key** (string), required
The key to project.
- **path** (string), required
The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
- **mode** (int32)
Optional: 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.

2
content/en/docs/reference/kubernetes-api/common-definitions/label-selector.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "A label selector is a label query over a set of resources."
title: "LabelSelector"
weight: 2
weight: 7
---

2
content/en/docs/reference/kubernetes-api/common-definitions/list-meta.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "ListMeta describes metadata that synthetic resources must have, including lists and various status objects."
title: "ListMeta"
weight: 3
weight: 8
---

2
content/en/docs/reference/kubernetes-api/common-definitions/local-object-reference.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace."
title: "LocalObjectReference"
weight: 4
weight: 9
---

72
content/en/docs/reference/kubernetes-api/common-definitions/node-affinity.md Normal file
View File

@ -0,0 +1,72 @@
---
api_metadata:
apiVersion: ""
import: "k8s.io/api/core/v1"
kind: "NodeAffinity"
content_type: "api_reference"
description: "Node affinity is a group of node affinity scheduling rules."
title: "NodeAffinity"
weight: 10
---
`import "k8s.io/api/core/v1"`
Node affinity is a group of node affinity scheduling rules.
<hr>
- **preferredDuringSchedulingIgnoredDuringExecution** ([]PreferredSchedulingTerm)
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.
<a name="PreferredSchedulingTerm"></a>
*An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).*
- **preferredDuringSchedulingIgnoredDuringExecution.preference** (NodeSelectorTerm), required
A node selector term, associated with the corresponding weight.
<a name="NodeSelectorTerm"></a>
*A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.*
- **preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
A list of node selector requirements by node's labels.
- **preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
A list of node selector requirements by node's fields.
- **preferredDuringSchedulingIgnoredDuringExecution.weight** (int32), required
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
- **requiredDuringSchedulingIgnoredDuringExecution** (NodeSelector)
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.
<a name="NodeSelector"></a>
*A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.*
- **requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms** ([]NodeSelectorTerm), required
Required. A list of node selector terms. The terms are ORed.
<a name="NodeSelectorTerm"></a>
*A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.*
- **requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
A list of node selector requirements by node's labels.
- **requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
A list of node selector requirements by node's fields.

2
content/en/docs/reference/kubernetes-api/common-definitions/node-selector-requirement.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values."
title: "NodeSelectorRequirement"
weight: 5
weight: 11
---

2
content/en/docs/reference/kubernetes-api/common-definitions/object-field-selector.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "ObjectFieldSelector selects an APIVersioned field of an object."
title: "ObjectFieldSelector"
weight: 6
weight: 12
---

2
content/en/docs/reference/kubernetes-api/common-definitions/object-meta.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."
title: "ObjectMeta"
weight: 7
weight: 13
---

2
content/en/docs/reference/kubernetes-api/common-definitions/object-reference.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "ObjectReference contains enough information to let you inspect or modify the referred object."
title: "ObjectReference"
weight: 8
weight: 14
---

2
content/en/docs/reference/kubernetes-api/common-definitions/patch.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "Patch is provided to give a concrete name and type to the Kubernetes PATCH request body."
title: "Patch"
weight: 9
weight: 15
---

73
content/en/docs/reference/kubernetes-api/common-definitions/pod-affinity.md Normal file
View File

@ -0,0 +1,73 @@
---
api_metadata:
apiVersion: ""
import: "k8s.io/api/core/v1"
kind: "PodAffinity"
content_type: "api_reference"
description: "Pod affinity is a group of inter pod affinity scheduling rules."
title: "PodAffinity"
weight: 16
---
`import "k8s.io/api/core/v1"`
Pod affinity is a group of inter pod affinity scheduling rules.
<hr>
- **preferredDuringSchedulingIgnoredDuringExecution** ([]WeightedPodAffinityTerm)
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.
<a name="WeightedPodAffinityTerm"></a>
*The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)*
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm** (PodAffinityTerm), required
Required. A pod affinity term, associated with the corresponding weight.
<a name="PodAffinityTerm"></a>
*Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running*
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.topologyKey** (string), required
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.
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
A label query over a set of resources, in this case pods.
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaces** ([]string)
namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
- **preferredDuringSchedulingIgnoredDuringExecution.weight** (int32), required
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
- **requiredDuringSchedulingIgnoredDuringExecution** ([]PodAffinityTerm)
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.
<a name="PodAffinityTerm"></a>
*Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running*
- **requiredDuringSchedulingIgnoredDuringExecution.topologyKey** (string), required
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.
- **requiredDuringSchedulingIgnoredDuringExecution.labelSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
A label query over a set of resources, in this case pods.
- **requiredDuringSchedulingIgnoredDuringExecution.namespaces** ([]string)
namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"

73
content/en/docs/reference/kubernetes-api/common-definitions/pod-anti-affinity.md Normal file
View File

@ -0,0 +1,73 @@
---
api_metadata:
apiVersion: ""
import: "k8s.io/api/core/v1"
kind: "PodAntiAffinity"
content_type: "api_reference"
description: "Pod anti affinity is a group of inter pod anti affinity scheduling rules."
title: "PodAntiAffinity"
weight: 17
---
`import "k8s.io/api/core/v1"`
Pod anti affinity is a group of inter pod anti affinity scheduling rules.
<hr>
- **preferredDuringSchedulingIgnoredDuringExecution** ([]WeightedPodAffinityTerm)
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.
<a name="WeightedPodAffinityTerm"></a>
*The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)*
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm** (PodAffinityTerm), required
Required. A pod affinity term, associated with the corresponding weight.
<a name="PodAffinityTerm"></a>
*Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running*
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.topologyKey** (string), required
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.
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
A label query over a set of resources, in this case pods.
- **preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaces** ([]string)
namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
- **preferredDuringSchedulingIgnoredDuringExecution.weight** (int32), required
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
- **requiredDuringSchedulingIgnoredDuringExecution** ([]PodAffinityTerm)
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.
<a name="PodAffinityTerm"></a>
*Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running*
- **requiredDuringSchedulingIgnoredDuringExecution.topologyKey** (string), required
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.
- **requiredDuringSchedulingIgnoredDuringExecution.labelSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
A label query over a set of resources, in this case pods.
- **requiredDuringSchedulingIgnoredDuringExecution.namespaces** ([]string)
namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"

2
content/en/docs/reference/kubernetes-api/common-definitions/quantity.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "Quantity is a fixed-point representation of a number."
title: "Quantity"
weight: 10
weight: 18
---

2
content/en/docs/reference/kubernetes-api/common-definitions/resource-field-selector.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "ResourceFieldSelector represents container resources (cpu, memory) and their output format."
title: "ResourceFieldSelector"
weight: 11
weight: 19
---

22
content/en/docs/reference/kubernetes-api/common-definitions/status.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "Status is a return value for calls that don't return other objects."
title: "Status"
weight: 12
weight: 20
---
@ -40,21 +40,21 @@ Status is a return value for calls that don't return other objects.
<a name="StatusCause"></a>
*StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.*
- **details.causes.field** (string)
- **details.causes.field** (string)
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
Examples:
"name" - the field "name" on the current resource
"items[0].name" - the field "name" on the first array entry in "items"
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
Examples:
"name" - the field "name" on the current resource
"items[0].name" - the field "name" on the first array entry in "items"
- **details.causes.message** (string)
- **details.causes.message** (string)
A human-readable description of the cause of the error. This field may be presented as-is to a reader.
A human-readable description of the cause of the error. This field may be presented as-is to a reader.
- **details.causes.reason** (string)
- **details.causes.reason** (string)
A machine-readable description of the cause of the error. If this value is empty there is no information available.
A machine-readable description of the cause of the error. If this value is empty there is no information available.
- **details.group** (string)

35
content/en/docs/reference/kubernetes-api/common-definitions/tcp-socket-action.md Normal file
View File

@ -0,0 +1,35 @@
---
api_metadata:
apiVersion: ""
import: "k8s.io/api/core/v1"
kind: "TCPSocketAction"
content_type: "api_reference"
description: "TCPSocketAction describes an action based on opening a socket."
title: "TCPSocketAction"
weight: 21
---
`import "k8s.io/api/core/v1"`
TCPSocketAction describes an action based on opening a socket
<hr>
- **port** (IntOrString), required
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.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **host** (string)
Optional: Host name to connect to, defaults to the pod IP.

2
content/en/docs/reference/kubernetes-api/common-definitions/typed-local-object-reference.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace."
title: "TypedLocalObjectReference"
weight: 13
weight: 22
---

2
content/en/docs/reference/kubernetes-api/config-and-storage-resources/config-map-v1.md
View File

@ -40,7 +40,7 @@ ConfigMap holds configuration data for pods to consume.
- **immutable** (boolean)
Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. This is a beta field enabled by ImmutableEphemeralVolumes feature gate.

18
content/en/docs/reference/kubernetes-api/config-and-storage-resources/csi-driver-v1.md
View File

@ -47,23 +47,17 @@ CSIDriverSpec is the specification of a CSIDriver.
- **attachRequired** (boolean)
attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called.
This field is immutable.
- **fsGroupPolicy** (string)
Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details. This field is alpha-level, and is only honored by servers that enable the CSIVolumeFSGroupPolicy feature gate.
This field is immutable.
- **podInfoOnMount** (boolean)
If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume
If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" iff the volume is an ephemeral inline volume
defined by a CSIVolumeSource, otherwise "false"
"csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver.
This field is immutable.
- **requiresRepublish** (boolean)
@ -71,7 +65,7 @@ CSIDriverSpec is the specification of a CSIDriver.
Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container.
This is a beta feature and only available when the CSIServiceAccountToken feature is enabled.
This is an alpha feature and only available when the CSIServiceAccountToken feature is enabled.
- **storageCapacity** (boolean)
@ -81,9 +75,7 @@ CSIDriverSpec is the specification of a CSIDriver.
Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published.
This field is immutable.
This is a beta field and only available when the CSIStorageCapacity feature is enabled. The default is false.
This is an alpha field and only available when the CSIStorageCapacity feature is enabled. The default is false.
- **tokenRequests** ([]TokenRequest)
@ -99,7 +91,7 @@ CSIDriverSpec is the specification of a CSIDriver.
Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically.
This is a beta feature and only available when the CSIServiceAccountToken feature is enabled.
This is an alpha feature and only available when the CSIServiceAccountToken feature is enabled.
<a name="TokenRequest"></a>
*TokenRequest contains parameters of a service account token.*
@ -117,8 +109,6 @@ CSIDriverSpec is the specification of a CSIDriver.
*Set: unique values will be kept during a merge*
volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. This field is beta.
This field is immutable.

4
content/en/docs/reference/kubernetes-api/config-and-storage-resources/csi-node-v1.md
View File

@ -68,9 +68,9 @@ CSINodeSpec holds information about the specification of all CSI drivers install
<a name="VolumeNodeResources"></a>
*VolumeNodeResources is a set of resource limits for scheduling of volumes.*
- **drivers.allocatable.count** (int32)
- **drivers.allocatable.count** (int32)
Maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is not specified, then the supported number of volumes on this node is unbounded.
Maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is not specified, then the supported number of volumes on this node is unbounded.
- **drivers.topologyKeys** ([]string)

566
content/en/docs/reference/kubernetes-api/config-and-storage-resources/csi-storage-capacity-v1beta1.md
View File

@ -1,566 +0,0 @@
---
api_metadata:
apiVersion: "storage.k8s.io/v1beta1"
import: "k8s.io/api/storage/v1beta1"
kind: "CSIStorageCapacity"
content_type: "api_reference"
description: "CSIStorageCapacity stores the result of one CSI GetCapacity call."
title: "CSIStorageCapacity v1beta1"
weight: 10
---
`apiVersion: storage.k8s.io/v1beta1`
`import "k8s.io/api/storage/v1beta1"`
## CSIStorageCapacity {#CSIStorageCapacity}
CSIStorageCapacity stores the result of one CSI GetCapacity call. For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes.
For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123"
The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero
The producer of these objects can decide which approach is more suitable.
They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity.
<hr>
- **apiVersion**: storage.k8s.io/v1beta1
- **kind**: CSIStorageCapacity
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
Standard object's metadata. The name has no particular meaning. It must be be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-\<uuid>, a generated name, or a reverse-domain name which ends with the unique CSI driver name.
Objects are namespaced.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **storageClassName** (string), required
The name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.
- **capacity** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.
The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable and treated like zero capacity.
- **maximumVolumeSize** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields.
This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim.
- **nodeTopology** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
NodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable.
## CSIStorageCapacityList {#CSIStorageCapacityList}
CSIStorageCapacityList is a collection of CSIStorageCapacity objects.
<hr>
- **apiVersion**: storage.k8s.io/v1beta1
- **kind**: CSIStorageCapacityList
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>), required
*Map: unique values on key name will be kept during a merge*
Items is the list of CSIStorageCapacity objects.
## Operations {#Operations}
<hr>
### `get` read the specified CSIStorageCapacity
#### HTTP Request
GET /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CSIStorageCapacity
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): OK
401: Unauthorized
### `list` list or watch objects of kind CSIStorageCapacity
#### HTTP Request
GET /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities
#### Parameters
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue</a>
- **fieldSelector** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector</a>
- **limit** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
- **resourceVersion** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch</a>
#### Response
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacityList" >}}">CSIStorageCapacityList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind CSIStorageCapacity
#### HTTP Request
GET /apis/storage.k8s.io/v1beta1/csistoragecapacities
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue</a>
- **fieldSelector** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector</a>
- **limit** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
- **resourceVersion** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch</a>
#### Response
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacityList" >}}">CSIStorageCapacityList</a>): OK
401: Unauthorized
### `create` create a CSIStorageCapacity
#### HTTP Request
POST /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities
#### Parameters
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>, required
- **dryRun** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
- **fieldManager** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): OK
201 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): Created
202 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): Accepted
401: Unauthorized
### `update` replace the specified CSIStorageCapacity
#### HTTP Request
PUT /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CSIStorageCapacity
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>, required
- **dryRun** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
- **fieldManager** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): OK
201 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): Created
401: Unauthorized
### `patch` partially update the specified CSIStorageCapacity
#### HTTP Request
PATCH /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CSIStorageCapacity
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>, required
- **dryRun** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
- **fieldManager** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
- **force** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../config-and-storage-resources/csi-storage-capacity-v1beta1#CSIStorageCapacity" >}}">CSIStorageCapacity</a>): OK
401: Unauthorized
### `delete` delete a CSIStorageCapacity
#### HTTP Request
DELETE /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CSIStorageCapacity
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy</a>
#### Response
200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a>): OK
202 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of CSIStorageCapacity
#### HTTP Request
DELETE /apis/storage.k8s.io/v1beta1/namespaces/{namespace}/csistoragecapacities
#### Parameters
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a>
- **continue** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue</a>
- **dryRun** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector</a>
- **limit** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
#### Response
200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a>): OK
401: Unauthorized

4
content/en/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1.md
View File

@ -65,11 +65,11 @@ PersistentVolumeClaimSpec describes the common attributes of storage devices and
- **resources.limits** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
- **resources.requests** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
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/
- **volumeName** (string)

241
content/en/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-v1.md
View File

@ -78,20 +78,20 @@ PersistentVolumeSpec is the specification of a persistent volume.
<a name="NodeSelector"></a>
*A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.*
- **nodeAffinity.required.nodeSelectorTerms** ([]NodeSelectorTerm), required
- **nodeAffinity.required.nodeSelectorTerms** ([]NodeSelectorTerm), required
Required. A list of node selector terms. The terms are ORed.
Required. A list of node selector terms. The terms are ORed.
<a name="NodeSelectorTerm"></a>
*A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.*
<a name="NodeSelectorTerm"></a>
*A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.*
- **nodeAffinity.required.nodeSelectorTerms.matchExpressions** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
- **nodeAffinity.required.nodeSelectorTerms.matchExpressions** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
A list of node selector requirements by node's labels.
A list of node selector requirements by node's labels.
- **nodeAffinity.required.nodeSelectorTerms.matchFields** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
- **nodeAffinity.required.nodeSelectorTerms.matchFields** ([]<a href="{{< ref "../common-definitions/node-selector-requirement#NodeSelectorRequirement" >}}">NodeSelectorRequirement</a>)
A list of node selector requirements by node's fields.
A list of node selector requirements by node's fields.
- **persistentVolumeReclaimPolicy** (string)
@ -252,13 +252,13 @@ PersistentVolumeSpec is the specification of a persistent volume.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **cephfs.secretRef.name** (string)
- **cephfs.secretRef.name** (string)
Name is unique within a namespace to reference a secret resource.
Name is unique within a namespace to reference a secret resource.
- **cephfs.secretRef.namespace** (string)
- **cephfs.secretRef.namespace** (string)
Namespace defines the space within which the secret name must be unique.
Namespace defines the space within which the secret name must be unique.
- **cephfs.user** (string)
@ -290,100 +290,13 @@ PersistentVolumeSpec is the specification of a persistent volume.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **cinder.secretRef.name** (string)
- **cinder.secretRef.name** (string)
Name is unique within a namespace to reference a secret resource.
Name is unique within a namespace to reference a secret resource.
- **cinder.secretRef.namespace** (string)
- **cinder.secretRef.namespace** (string)
Namespace defines the space within which the secret name must be unique.
- **csi** (CSIPersistentVolumeSource)
CSI represents storage that is handled by an external CSI driver (Beta feature).
<a name="CSIPersistentVolumeSource"></a>
*Represents storage that is managed by an external CSI volume driver (Beta feature)*
- **csi.driver** (string), required
Driver is the name of the driver to use for this volume. Required.
- **csi.volumeHandle** (string), required
VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
- **csi.controllerExpandSecretRef** (SecretReference)
ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This is an alpha field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **csi.controllerExpandSecretRef.name** (string)
Name is unique within a namespace to reference a secret resource.
- **csi.controllerExpandSecretRef.namespace** (string)
Namespace defines the space within which the secret name must be unique.
- **csi.controllerPublishSecretRef** (SecretReference)
ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **csi.controllerPublishSecretRef.name** (string)
Name is unique within a namespace to reference a secret resource.
- **csi.controllerPublishSecretRef.namespace** (string)
Namespace defines the space within which the secret name must be unique.
- **csi.fsType** (string)
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
- **csi.nodePublishSecretRef** (SecretReference)
NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **csi.nodePublishSecretRef.name** (string)
Name is unique within a namespace to reference a secret resource.
- **csi.nodePublishSecretRef.namespace** (string)
Namespace defines the space within which the secret name must be unique.
- **csi.nodeStageSecretRef** (SecretReference)
NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **csi.nodeStageSecretRef.name** (string)
Name is unique within a namespace to reference a secret resource.
- **csi.nodeStageSecretRef.namespace** (string)
Namespace defines the space within which the secret name must be unique.
- **csi.readOnly** (boolean)
Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
- **csi.volumeAttributes** (map[string]string)
Attributes of the volume to publish.
Namespace defines the space within which the secret name must be unique.
- **fc** (FCVolumeSource)
@ -442,13 +355,13 @@ PersistentVolumeSpec is the specification of a persistent volume.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **flexVolume.secretRef.name** (string)
- **flexVolume.secretRef.name** (string)
Name is unique within a namespace to reference a secret resource.
Name is unique within a namespace to reference a secret resource.
- **flexVolume.secretRef.namespace** (string)
- **flexVolume.secretRef.namespace** (string)
Namespace defines the space within which the secret name must be unique.
Namespace defines the space within which the secret name must be unique.
- **flocker** (FlockerVolumeSource)
@ -567,13 +480,13 @@ PersistentVolumeSpec is the specification of a persistent volume.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **iscsi.secretRef.name** (string)
- **iscsi.secretRef.name** (string)
Name is unique within a namespace to reference a secret resource.
Name is unique within a namespace to reference a secret resource.
- **iscsi.secretRef.namespace** (string)
- **iscsi.secretRef.namespace** (string)
Namespace defines the space within which the secret name must be unique.
Namespace defines the space within which the secret name must be unique.
- **nfs** (NFSVolumeSource)
@ -697,13 +610,13 @@ PersistentVolumeSpec is the specification of a persistent volume.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **rbd.secretRef.name** (string)
- **rbd.secretRef.name** (string)
Name is unique within a namespace to reference a secret resource.
Name is unique within a namespace to reference a secret resource.
- **rbd.secretRef.namespace** (string)
- **rbd.secretRef.namespace** (string)
Namespace defines the space within which the secret name must be unique.
Namespace defines the space within which the secret name must be unique.
- **rbd.user** (string)
@ -727,13 +640,13 @@ PersistentVolumeSpec is the specification of a persistent volume.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **scaleIO.secretRef.name** (string)
- **scaleIO.secretRef.name** (string)
Name is unique within a namespace to reference a secret resource.
Name is unique within a namespace to reference a secret resource.
- **scaleIO.secretRef.namespace** (string)
- **scaleIO.secretRef.namespace** (string)
Namespace defines the space within which the secret name must be unique.
Namespace defines the space within which the secret name must be unique.
- **scaleIO.system** (string), required
@ -817,6 +730,96 @@ PersistentVolumeSpec is the specification of a persistent volume.
Storage Policy Based Management (SPBM) profile name.
### Beta level
- **csi** (CSIPersistentVolumeSource)
CSI represents storage that is handled by an external CSI driver (Beta feature).
<a name="CSIPersistentVolumeSource"></a>
*Represents storage that is managed by an external CSI volume driver (Beta feature)*
- **csi.driver** (string), required
Driver is the name of the driver to use for this volume. Required.
- **csi.volumeHandle** (string), required
VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.
- **csi.controllerExpandSecretRef** (SecretReference)
ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This is an alpha field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **csi.controllerExpandSecretRef.name** (string)
Name is unique within a namespace to reference a secret resource.
- **csi.controllerExpandSecretRef.namespace** (string)
Namespace defines the space within which the secret name must be unique.
- **csi.controllerPublishSecretRef** (SecretReference)
ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **csi.controllerPublishSecretRef.name** (string)
Name is unique within a namespace to reference a secret resource.
- **csi.controllerPublishSecretRef.namespace** (string)
Namespace defines the space within which the secret name must be unique.
- **csi.fsType** (string)
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".
- **csi.nodePublishSecretRef** (SecretReference)
NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **csi.nodePublishSecretRef.name** (string)
Name is unique within a namespace to reference a secret resource.
- **csi.nodePublishSecretRef.namespace** (string)
Namespace defines the space within which the secret name must be unique.
- **csi.nodeStageSecretRef** (SecretReference)
NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.
<a name="SecretReference"></a>
*SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace*
- **csi.nodeStageSecretRef.name** (string)
Name is unique within a namespace to reference a secret resource.
- **csi.nodeStageSecretRef.namespace** (string)
Namespace defines the space within which the secret name must be unique.
- **csi.readOnly** (boolean)
Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
- **csi.volumeAttributes** (map[string]string)
Attributes of the volume to publish.
## PersistentVolumeStatus {#PersistentVolumeStatus}

4
content/en/docs/reference/kubernetes-api/config-and-storage-resources/secret-v1.md
View File

@ -36,11 +36,11 @@ Secret holds secret data of a certain type. The total bytes of the values in the
- **immutable** (boolean)
Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. This is a beta field enabled by ImmutableEphemeralVolumes feature gate.
- **stringData** (map[string]string)
stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API.
stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.
- **type** (string)

8
content/en/docs/reference/kubernetes-api/config-and-storage-resources/storage-class-v1.md
View File

@ -54,13 +54,13 @@ StorageClasses are non-namespaced; the name of the storage class according to et
<a name="TopologySelectorLabelRequirement"></a>
*A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.*
- **allowedTopologies.matchLabelExpressions.key** (string), required
- **allowedTopologies.matchLabelExpressions.key** (string), required
The label key that the selector applies to.
The label key that the selector applies to.
- **allowedTopologies.matchLabelExpressions.values** ([]string), required
- **allowedTopologies.matchLabelExpressions.values** ([]string), required
An array of string values. One value must match the label to be selected. Each entry in Values is ORed.
An array of string values. One value must match the label to be selected. Each entry in Values is ORed.
- **mountOptions** ([]string)

2
content/en/docs/reference/kubernetes-api/config-and-storage-resources/volume-attachment-v1.md
View File

@ -67,7 +67,7 @@ VolumeAttachmentSpec is the specification of a VolumeAttachment request.
- **source.inlineVolumeSpec** (<a href="{{< ref "../config-and-storage-resources/persistent-volume-v1#PersistentVolumeSpec" >}}">PersistentVolumeSpec</a>)
inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature.
inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is alpha-level and is only honored by servers that enabled the CSIMigration feature.
- **source.persistentVolumeName** (string)

221
content/en/docs/reference/kubernetes-api/config-and-storage-resources/volume.md
View File

@ -14,8 +14,6 @@ weight: 3
`import "k8s.io/api/core/v1"`
## Volume {#Volume}
Volume represents a named volume in a pod that may be accessed by any container in the pod.
<hr>
@ -26,7 +24,7 @@ Volume represents a named volume in a pod that may be accessed by any container
### Exposed Persistent volumes
### Exposed Persistent volumes {#Exposed-Persistent-volumes}
- **persistentVolumeClaim** (PersistentVolumeClaimVolumeSource)
@ -44,7 +42,7 @@ Volume represents a named volume in a pod that may be accessed by any container
Will force the ReadOnly setting in VolumeMounts. Default false.
### Projections
### Projections {#Projections}
- **configMap** (ConfigMapVolumeSource)
@ -68,7 +66,7 @@ Volume represents a named volume in a pod that may be accessed by any container
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.
- **configMap.items** ([]<a href="{{< ref "../config-and-storage-resources/volume#KeyToPath" >}}">KeyToPath</a>)
- **configMap.items** ([]<a href="{{< ref "../common-definitions/key-to-path#KeyToPath" >}}">KeyToPath</a>)
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 '..'.
@ -93,7 +91,7 @@ Volume represents a named volume in a pod that may be accessed by any container
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.
- **secret.items** ([]<a href="{{< ref "../config-and-storage-resources/volume#KeyToPath" >}}">KeyToPath</a>)
- **secret.items** ([]<a href="{{< ref "../common-definitions/key-to-path#KeyToPath" >}}">KeyToPath</a>)
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 '..'.
@ -108,7 +106,7 @@ Volume represents a named volume in a pod that may be accessed by any container
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.
- **downwardAPI.items** ([]<a href="{{< ref "../config-and-storage-resources/volume#DownwardAPIVolumeFile" >}}">DownwardAPIVolumeFile</a>)
- **downwardAPI.items** ([]<a href="{{< ref "../common-definitions/downward-api-volume-file#DownwardAPIVolumeFile" >}}">DownwardAPIVolumeFile</a>)
Items is a list of downward API volume file
@ -130,79 +128,79 @@ Volume represents a named volume in a pod that may be accessed by any container
<a name="VolumeProjection"></a>
*Projection that may be projected along with other supported volume types*
- **projected.sources.configMap** (ConfigMapProjection)
- **projected.sources.configMap** (ConfigMapProjection)
information about the configMap data to project
information about the configMap data to project
<a name="ConfigMapProjection"></a>
*Adapts a ConfigMap into a projected volume.
The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.*
<a name="ConfigMapProjection"></a>
*Adapts a ConfigMap into a projected volume.
The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.*
- **projected.sources.configMap.name** (string)
- **projected.sources.configMap.name** (string)
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **projected.sources.configMap.optional** (boolean)
- **projected.sources.configMap.optional** (boolean)
Specify whether the ConfigMap or its keys must be defined
Specify whether the ConfigMap or its keys must be defined
- **projected.sources.configMap.items** ([]<a href="{{< ref "../config-and-storage-resources/volume#KeyToPath" >}}">KeyToPath</a>)
- **projected.sources.configMap.items** ([]<a href="{{< ref "../common-definitions/key-to-path#KeyToPath" >}}">KeyToPath</a>)
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 '..'.
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 '..'.
- **projected.sources.downwardAPI** (DownwardAPIProjection)
- **projected.sources.downwardAPI** (DownwardAPIProjection)
information about the downwardAPI data to project
information about the downwardAPI data to project
<a name="DownwardAPIProjection"></a>
*Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.*
<a name="DownwardAPIProjection"></a>
*Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.*
- **projected.sources.downwardAPI.items** ([]<a href="{{< ref "../config-and-storage-resources/volume#DownwardAPIVolumeFile" >}}">DownwardAPIVolumeFile</a>)
- **projected.sources.downwardAPI.items** ([]<a href="{{< ref "../common-definitions/downward-api-volume-file#DownwardAPIVolumeFile" >}}">DownwardAPIVolumeFile</a>)
Items is a list of DownwardAPIVolume file
Items is a list of DownwardAPIVolume file
- **projected.sources.secret** (SecretProjection)
- **projected.sources.secret** (SecretProjection)
information about the secret data to project
information about the secret data to project
<a name="SecretProjection"></a>
*Adapts a secret into a projected volume.
The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.*
<a name="SecretProjection"></a>
*Adapts a secret into a projected volume.
The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.*
- **projected.sources.secret.name** (string)
- **projected.sources.secret.name** (string)
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **projected.sources.secret.optional** (boolean)
- **projected.sources.secret.optional** (boolean)
Specify whether the Secret or its key must be defined
Specify whether the Secret or its key must be defined
- **projected.sources.secret.items** ([]<a href="{{< ref "../config-and-storage-resources/volume#KeyToPath" >}}">KeyToPath</a>)
- **projected.sources.secret.items** ([]<a href="{{< ref "../common-definitions/key-to-path#KeyToPath" >}}">KeyToPath</a>)
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 '..'.
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 '..'.
- **projected.sources.serviceAccountToken** (ServiceAccountTokenProjection)
- **projected.sources.serviceAccountToken** (ServiceAccountTokenProjection)
information about the serviceAccountToken data to project
information about the serviceAccountToken data to project
<a name="ServiceAccountTokenProjection"></a>
*ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).*
<a name="ServiceAccountTokenProjection"></a>
*ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).*
- **projected.sources.serviceAccountToken.path** (string), required
- **projected.sources.serviceAccountToken.path** (string), required
Path is the path relative to the mount point of the file to project the token into.
Path is the path relative to the mount point of the file to project the token into.
- **projected.sources.serviceAccountToken.audience** (string)
- **projected.sources.serviceAccountToken.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.
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.
- **projected.sources.serviceAccountToken.expirationSeconds** (int64)
- **projected.sources.serviceAccountToken.expirationSeconds** (int64)
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.
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.
### Local / Temporary Directory
### Local / Temporary Directory {#Local-Temporary-Directory}
- **emptyDir** (EmptyDirVolumeSource)
@ -235,7 +233,7 @@ Volume represents a named volume in a pod that may be accessed by any container
Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
### Persistent volumes
### Persistent volumes {#Persistent-volumes}
- **awsElasticBlockStore** (AWSElasticBlockStoreVolumeSource)
@ -367,33 +365,6 @@ Volume represents a named volume in a pod that may be accessed by any container
Optional: points to a secret object containing parameters used to connect to OpenStack.
- **csi** (CSIVolumeSource)
CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
<a name="CSIVolumeSource"></a>
*Represents a source location of a volume to mount, managed by an external CSI driver*
- **csi.driver** (string), required
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.
- **csi.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.
- **csi.nodePublishSecretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)
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.
- **csi.readOnly** (boolean)
Specifies a read-only configuration for the volume. Defaults to false (read/write).
- **csi.volumeAttributes** (map[string]string)
VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
- **fc** (FCVolumeSource)
FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
@ -778,12 +749,42 @@ Volume represents a named volume in a pod that may be accessed by any container
Storage Policy Based Management (SPBM) profile name.
### Alpha level
### Beta level {#Beta-level}
- **csi** (CSIVolumeSource)
CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
<a name="CSIVolumeSource"></a>
*Represents a source location of a volume to mount, managed by an external CSI driver*
- **csi.driver** (string), required
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.
- **csi.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.
- **csi.nodePublishSecretRef** (<a href="{{< ref "../common-definitions/local-object-reference#LocalObjectReference" >}}">LocalObjectReference</a>)
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.
- **csi.readOnly** (boolean)
Specifies a read-only configuration for the volume. Defaults to false (read/write).
- **csi.volumeAttributes** (map[string]string)
VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
### Alpha level {#Alpha-level}
- **ephemeral** (EphemeralVolumeSource)
Ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.
Ephemeral represents a volume that is handled by a cluster storage driver (Alpha feature). The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.
Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity
tracking are needed,
@ -797,12 +798,14 @@ Volume represents a named volume in a pod that may be accessed by any container
Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.
A pod can use both types of ephemeral volumes and persistent volumes at the same time.
This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled.
<a name="EphemeralVolumeSource"></a>
*Represents an ephemeral volume that is handled by a normal storage driver.*
- **ephemeral.readOnly** (boolean)
Specifies a read-only configuration for the volume. Defaults to false (read/write).
- **ephemeral.volumeClaimTemplate** (PersistentVolumeClaimTemplate)
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).
@ -816,15 +819,15 @@ Volume represents a named volume in a pod that may be accessed by any container
<a name="PersistentVolumeClaimTemplate"></a>
*PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.*
- **ephemeral.volumeClaimTemplate.spec** (<a href="{{< ref "../config-and-storage-resources/persistent-volume-claim-v1#PersistentVolumeClaimSpec" >}}">PersistentVolumeClaimSpec</a>), required
- **ephemeral.volumeClaimTemplate.spec** (<a href="{{< ref "../config-and-storage-resources/persistent-volume-claim-v1#PersistentVolumeClaimSpec" >}}">PersistentVolumeClaimSpec</a>), required
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.
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.
- **ephemeral.volumeClaimTemplate.metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
- **ephemeral.volumeClaimTemplate.metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
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.
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.
### Deprecated
### Deprecated {#Deprecated}
- **gitRepo** (GitRepoVolumeSource)
@ -850,51 +853,3 @@ Volume represents a named volume in a pod that may be accessed by any container
## DownwardAPIVolumeFile {#DownwardAPIVolumeFile}
DownwardAPIVolumeFile represents information to create the file containing the pod field
<hr>
- **path** (string), required
Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
- **fieldRef** (<a href="{{< ref "../common-definitions/object-field-selector#ObjectFieldSelector" >}}">ObjectFieldSelector</a>)
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
- **mode** (int32)
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.
- **resourceFieldRef** (<a href="{{< ref "../common-definitions/resource-field-selector#ResourceFieldSelector" >}}">ResourceFieldSelector</a>)
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
## KeyToPath {#KeyToPath}
Maps a string key to a path within a volume.
<hr>
- **key** (string), required
The key to project.
- **path** (string), required
The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
- **mode** (int32)
Optional: 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.

352
content/en/docs/reference/kubernetes-api/extend-resources/custom-resource-definition-v1.md
View File

@ -112,29 +112,29 @@ CustomResourceDefinitionSpec describes how a user wants their resource to appear
<a name="CustomResourceColumnDefinition"></a>
*CustomResourceColumnDefinition specifies a column for server side printing.*
- **versions.additionalPrinterColumns.jsonPath** (string), required
- **versions.additionalPrinterColumns.jsonPath** (string), required
jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column.
jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column.
- **versions.additionalPrinterColumns.name** (string), required
- **versions.additionalPrinterColumns.name** (string), required
name is a human readable name for the column.
name is a human readable name for the column.
- **versions.additionalPrinterColumns.type** (string), required
- **versions.additionalPrinterColumns.type** (string), required
type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.
type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.
- **versions.additionalPrinterColumns.description** (string)
- **versions.additionalPrinterColumns.description** (string)
description is a human readable description of this column.
description is a human readable description of this column.
- **versions.additionalPrinterColumns.format** (string)
- **versions.additionalPrinterColumns.format** (string)
format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.
format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.
- **versions.additionalPrinterColumns.priority** (int32)
- **versions.additionalPrinterColumns.priority** (int32)
priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0.
priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0.
- **versions.deprecated** (boolean)
@ -151,9 +151,9 @@ CustomResourceDefinitionSpec describes how a user wants their resource to appear
<a name="CustomResourceValidation"></a>
*CustomResourceValidation is a list of validation methods for CustomResources.*
- **versions.schema.openAPIV3Schema** (<a href="{{< ref "../extend-resources/custom-resource-definition-v1#JSONSchemaProps" >}}">JSONSchemaProps</a>)
- **versions.schema.openAPIV3Schema** (<a href="{{< ref "../common-definitions/json-schema-props#JSONSchemaProps" >}}">JSONSchemaProps</a>)
openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.
openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.
- **versions.subresources** (CustomResourceSubresources)
@ -162,31 +162,31 @@ CustomResourceDefinitionSpec describes how a user wants their resource to appear
<a name="CustomResourceSubresources"></a>
*CustomResourceSubresources defines the status and scale subresources for CustomResources.*
- **versions.subresources.scale** (CustomResourceSubresourceScale)
- **versions.subresources.scale** (CustomResourceSubresourceScale)
scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object.
scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object.
<a name="CustomResourceSubresourceScale"></a>
*CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.*
<a name="CustomResourceSubresourceScale"></a>
*CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.*
- **versions.subresources.scale.specReplicasPath** (string), required
- **versions.subresources.scale.specReplicasPath** (string), required
specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET.
specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET.
- **versions.subresources.scale.statusReplicasPath** (string), required
- **versions.subresources.scale.statusReplicasPath** (string), required
statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0.
statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0.
- **versions.subresources.scale.labelSelectorPath** (string)
- **versions.subresources.scale.labelSelectorPath** (string)
labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string.
labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string.
- **versions.subresources.status** (CustomResourceSubresourceStatus)
- **versions.subresources.status** (CustomResourceSubresourceStatus)
status indicates the custom resource should serve a `/status` subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object.
status indicates the custom resource should serve a `/status` subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object.
<a name="CustomResourceSubresourceStatus"></a>
*CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources. Status is represented by the `.status` JSON path inside of a CustomResource. When set, * exposes a /status subresource for the custom resource * PUT requests to the /status subresource take a custom resource object, and ignore changes to anything except the status stanza * PUT/POST/PATCH requests to the custom resource ignore changes to the status stanza*
<a name="CustomResourceSubresourceStatus"></a>
*CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources. Status is represented by the `.status` JSON path inside of a CustomResource. When set, * exposes a /status subresource for the custom resource * PUT requests to the /status subresource take a custom resource object, and ignore changes to anything except the status stanza * PUT/POST/PATCH requests to the custom resource ignore changes to the status stanza*
- **conversion** (CustomResourceConversion)
@ -207,59 +207,59 @@ CustomResourceDefinitionSpec describes how a user wants their resource to appear
<a name="WebhookConversion"></a>
*WebhookConversion describes how to call a conversion webhook*
- **conversion.webhook.conversionReviewVersions** ([]string), required
- **conversion.webhook.conversionReviewVersions** ([]string), required
conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail.
conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail.
- **conversion.webhook.clientConfig** (WebhookClientConfig)
- **conversion.webhook.clientConfig** (WebhookClientConfig)
clientConfig is the instructions for how to call the webhook if strategy is `Webhook`.
clientConfig is the instructions for how to call the webhook if strategy is `Webhook`.
<a name="WebhookClientConfig"></a>
*WebhookClientConfig contains the information to make a TLS connection with the webhook.*
<a name="WebhookClientConfig"></a>
*WebhookClientConfig contains the information to make a TLS connection with the webhook.*
- **conversion.webhook.clientConfig.caBundle** ([]byte)
- **conversion.webhook.clientConfig.caBundle** ([]byte)
caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
- **conversion.webhook.clientConfig.service** (ServiceReference)
- **conversion.webhook.clientConfig.service** (ServiceReference)
service is a reference to the service for this webhook. Either service or url must be specified.
If the webhook is running within the cluster, then you should use `service`.
service is a reference to the service for this webhook. Either service or url must be specified.
If the webhook is running within the cluster, then you should use `service`.
<a name="ServiceReference"></a>
*ServiceReference holds a reference to Service.legacy.k8s.io*
<a name="ServiceReference"></a>
*ServiceReference holds a reference to Service.legacy.k8s.io*
- **conversion.webhook.clientConfig.service.name** (string), required
- **conversion.webhook.clientConfig.service.name** (string), required
name is the name of the service. Required
name is the name of the service. Required
- **conversion.webhook.clientConfig.service.namespace** (string), required
- **conversion.webhook.clientConfig.service.namespace** (string), required
namespace is the namespace of the service. Required
namespace is the namespace of the service. Required
- **conversion.webhook.clientConfig.service.path** (string)
- **conversion.webhook.clientConfig.service.path** (string)
path is an optional URL path at which the webhook will be contacted.
path is an optional URL path at which the webhook will be contacted.
- **conversion.webhook.clientConfig.service.port** (int32)
- **conversion.webhook.clientConfig.service.port** (int32)
port is an optional service port at which the webhook will be contacted. `port` should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.
port is an optional service port at which the webhook will be contacted. `port` should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.
- **conversion.webhook.clientConfig.url** (string)
- **conversion.webhook.clientConfig.url** (string)
url gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified.
The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address.
Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.
The scheme must be "https"; the URL must begin with "https://".
A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.
Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
url gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified.
The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address.
Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installations are likely to be non-portable or not readily run in a new cluster.
The scheme must be "https"; the URL must begin with "https://".
A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.
Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
- **preserveUnknownFields** (boolean)
@ -269,218 +269,6 @@ CustomResourceDefinitionSpec describes how a user wants their resource to appear
## JSONSchemaProps {#JSONSchemaProps}
JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).
<hr>
- **$ref** (string)
- **$schema** (string)
- **additionalItems** (JSONSchemaPropsOrBool)
<a name="JSONSchemaPropsOrBool"></a>
*JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.*
- **additionalProperties** (JSONSchemaPropsOrBool)
<a name="JSONSchemaPropsOrBool"></a>
*JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.*
- **allOf** ([]<a href="{{< ref "../extend-resources/custom-resource-definition-v1#JSONSchemaProps" >}}">JSONSchemaProps</a>)
- **anyOf** ([]<a href="{{< ref "../extend-resources/custom-resource-definition-v1#JSONSchemaProps" >}}">JSONSchemaProps</a>)
- **default** (JSON)
default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false.
<a name="JSON"></a>
*JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.*
- **definitions** (map[string]<a href="{{< ref "../extend-resources/custom-resource-definition-v1#JSONSchemaProps" >}}">JSONSchemaProps</a>)
- **dependencies** (map[string]JSONSchemaPropsOrStringArray)
<a name="JSONSchemaPropsOrStringArray"></a>
*JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array.*
- **description** (string)
- **enum** ([]JSON)
<a name="JSON"></a>
*JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.*
- **example** (JSON)
<a name="JSON"></a>
*JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.*
- **exclusiveMaximum** (boolean)
- **exclusiveMinimum** (boolean)
- **externalDocs** (ExternalDocumentation)
<a name="ExternalDocumentation"></a>
*ExternalDocumentation allows referencing an external resource for extended documentation.*
- **externalDocs.description** (string)
- **externalDocs.url** (string)
- **format** (string)
format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
- bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.
- **id** (string)
- **items** (JSONSchemaPropsOrArray)
<a name="JSONSchemaPropsOrArray"></a>
*JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.*
- **maxItems** (int64)
- **maxLength** (int64)
- **maxProperties** (int64)
- **maximum** (double)
- **minItems** (int64)
- **minLength** (int64)
- **minProperties** (int64)
- **minimum** (double)
- **multipleOf** (double)
- **not** (<a href="{{< ref "../extend-resources/custom-resource-definition-v1#JSONSchemaProps" >}}">JSONSchemaProps</a>)
- **nullable** (boolean)
- **oneOf** ([]<a href="{{< ref "../extend-resources/custom-resource-definition-v1#JSONSchemaProps" >}}">JSONSchemaProps</a>)
- **pattern** (string)
- **patternProperties** (map[string]<a href="{{< ref "../extend-resources/custom-resource-definition-v1#JSONSchemaProps" >}}">JSONSchemaProps</a>)
- **properties** (map[string]<a href="{{< ref "../extend-resources/custom-resource-definition-v1#JSONSchemaProps" >}}">JSONSchemaProps</a>)
- **required** ([]string)
- **title** (string)
- **type** (string)
- **uniqueItems** (boolean)
- **x-kubernetes-embedded-resource** (boolean)
x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata).
- **x-kubernetes-int-or-string** (boolean)
x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns:
1) anyOf:
- type: integer
- type: string
2) allOf:
- anyOf:
- type: integer
- type: string
- ... zero or more
- **x-kubernetes-list-map-keys** ([]string)
x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map.
This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported).
The properties specified must either be required or have a default value, to ensure those properties are present for all list items.
- **x-kubernetes-list-type** (string)
x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values:
1) `atomic`: the list is treated as a single entity, like a scalar.
Atomic lists will be entirely replaced when updated. This extension
may be used on any type of list (struct, scalar, ...).
2) `set`:
Sets are lists that must not have multiple items with the same value. Each
value must be a scalar, an object with x-kubernetes-map-type `atomic` or an
array with x-kubernetes-list-type `atomic`.
3) `map`:
These lists are like maps in that their elements have a non-index key
used to identify them. Order is preserved upon merge. The map tag
must only be used on a list with elements of type object.
Defaults to atomic for arrays.
- **x-kubernetes-map-type** (string)
x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values:
1) `granular`:
These maps are actual maps (key-value pairs) and each fields are independent
from each other (they can each be manipulated by separate actors). This is
the default behaviour for all maps.
2) `atomic`: the list is treated as a single entity, like a scalar.
Atomic maps will be entirely replaced when updated.
- **x-kubernetes-preserve-unknown-fields** (boolean)
x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden.
## CustomResourceDefinitionStatus {#CustomResourceDefinitionStatus}
CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition
@ -520,8 +308,6 @@ CustomResourceDefinitionStatus indicates the state of the CustomResourceDefiniti
- **conditions** ([]CustomResourceDefinitionCondition)
*Map: unique values on key type will be kept during a merge*
conditions indicate state for particular aspects of a CustomResourceDefinition
<a name="CustomResourceDefinitionCondition"></a>
@ -564,21 +350,19 @@ CustomResourceDefinitionList is a list of CustomResourceDefinition objects.
<hr>
- **items** ([]<a href="{{< ref "../extend-resources/custom-resource-definition-v1#CustomResourceDefinition" >}}">CustomResourceDefinition</a>), required
- **apiVersion**: apiextensions.k8s.io/v1
items list individual CustomResourceDefinition objects
- **apiVersion** (string)
- **kind**: CustomResourceDefinitionList
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** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
- **items** ([]<a href="{{< ref "../extend-resources/custom-resource-definition-v1#CustomResourceDefinition" >}}">CustomResourceDefinition</a>), required
items list individual CustomResourceDefinition objects

90
content/en/docs/reference/kubernetes-api/extend-resources/mutating-webhook-configuration-v1.md
View File

@ -50,48 +50,48 @@ MutatingWebhookConfiguration describes the configuration of and admission webhoo
<a name="WebhookClientConfig"></a>
*WebhookClientConfig contains the information to make a TLS connection with the webhook*
- **webhooks.clientConfig.caBundle** ([]byte)
- **webhooks.clientConfig.caBundle** ([]byte)
`caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
`caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
- **webhooks.clientConfig.service** (ServiceReference)
- **webhooks.clientConfig.service** (ServiceReference)
`service` is a reference to the service for this webhook. Either `service` or `url` must be specified.
If the webhook is running within the cluster, then you should use `service`.
`service` is a reference to the service for this webhook. Either `service` or `url` must be specified.
If the webhook is running within the cluster, then you should use `service`.
<a name="ServiceReference"></a>
*ServiceReference holds a reference to Service.legacy.k8s.io*
<a name="ServiceReference"></a>
*ServiceReference holds a reference to Service.legacy.k8s.io*
- **webhooks.clientConfig.service.name** (string), required
- **webhooks.clientConfig.service.name** (string), required
`name` is the name of the service. Required
`name` is the name of the service. Required
- **webhooks.clientConfig.service.namespace** (string), required
- **webhooks.clientConfig.service.namespace** (string), required
`namespace` is the namespace of the service. Required
`namespace` is the namespace of the service. Required
- **webhooks.clientConfig.service.path** (string)
- **webhooks.clientConfig.service.path** (string)
`path` is an optional URL path which will be sent in any request to this service.
`path` is an optional URL path which will be sent in any request to this service.
- **webhooks.clientConfig.service.port** (int32)
- **webhooks.clientConfig.service.port** (int32)
If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).
If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).
- **webhooks.clientConfig.url** (string)
- **webhooks.clientConfig.url** (string)
`url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified.
The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address.
Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.
The scheme must be "https"; the URL must begin with "https://".
A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.
Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
`url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified.
The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address.
Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installations are likely to be non-portable or not readily run in a new cluster.
The scheme must be "https"; the URL must begin with "https://".
A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.
Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
- **webhooks.name** (string), required
@ -99,7 +99,7 @@ MutatingWebhookConfiguration describes the configuration of and admission webhoo
- **webhooks.sideEffects** (string), required
SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some.
SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission change and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some.
- **webhooks.failurePolicy** (string)
@ -170,31 +170,31 @@ MutatingWebhookConfiguration describes the configuration of and admission webhoo
<a name="RuleWithOperations"></a>
*RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.*
- **webhooks.rules.apiGroups** ([]string)
- **webhooks.rules.apiGroups** ([]string)
APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
- **webhooks.rules.apiVersions** ([]string)
- **webhooks.rules.apiVersions** ([]string)
APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
- **webhooks.rules.operations** ([]string)
- **webhooks.rules.operations** ([]string)
Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
- **webhooks.rules.resources** ([]string)
- **webhooks.rules.resources** ([]string)
Resources is a list of resources this rule applies to.
For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources.
If wildcard is present, the validation rule will ensure resources do not overlap with each other.
Depending on the enclosing object, subresources might not be allowed. Required.
Resources is a list of resources this rule applies to.
For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources.
If wildcard is present, the validation rule will ensure resources do not overlap with each other.
Depending on the enclosing object, subresources might not be allowed. Required.
- **webhooks.rules.scope** (string)
- **webhooks.rules.scope** (string)
scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
- **webhooks.timeoutSeconds** (int32)

90
content/en/docs/reference/kubernetes-api/extend-resources/validating-webhook-configuration-v1.md
View File

@ -50,48 +50,48 @@ ValidatingWebhookConfiguration describes the configuration of and admission webh
<a name="WebhookClientConfig"></a>
*WebhookClientConfig contains the information to make a TLS connection with the webhook*
- **webhooks.clientConfig.caBundle** ([]byte)
- **webhooks.clientConfig.caBundle** ([]byte)
`caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
`caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.
- **webhooks.clientConfig.service** (ServiceReference)
- **webhooks.clientConfig.service** (ServiceReference)
`service` is a reference to the service for this webhook. Either `service` or `url` must be specified.
If the webhook is running within the cluster, then you should use `service`.
`service` is a reference to the service for this webhook. Either `service` or `url` must be specified.
If the webhook is running within the cluster, then you should use `service`.
<a name="ServiceReference"></a>
*ServiceReference holds a reference to Service.legacy.k8s.io*
<a name="ServiceReference"></a>
*ServiceReference holds a reference to Service.legacy.k8s.io*
- **webhooks.clientConfig.service.name** (string), required
- **webhooks.clientConfig.service.name** (string), required
`name` is the name of the service. Required
`name` is the name of the service. Required
- **webhooks.clientConfig.service.namespace** (string), required
- **webhooks.clientConfig.service.namespace** (string), required
`namespace` is the namespace of the service. Required
`namespace` is the namespace of the service. Required
- **webhooks.clientConfig.service.path** (string)
- **webhooks.clientConfig.service.path** (string)
`path` is an optional URL path which will be sent in any request to this service.
`path` is an optional URL path which will be sent in any request to this service.
- **webhooks.clientConfig.service.port** (int32)
- **webhooks.clientConfig.service.port** (int32)
If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).
If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive).
- **webhooks.clientConfig.url** (string)
- **webhooks.clientConfig.url** (string)
`url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified.
The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address.
Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster.
The scheme must be "https"; the URL must begin with "https://".
A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.
Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
`url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified.
The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address.
Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installations are likely to be non-portable or not readily run in a new cluster.
The scheme must be "https"; the URL must begin with "https://".
A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.
Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
- **webhooks.name** (string), required
@ -99,7 +99,7 @@ ValidatingWebhookConfiguration describes the configuration of and admission webh
- **webhooks.sideEffects** (string), required
SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some.
SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission change and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some.
- **webhooks.failurePolicy** (string)
@ -160,31 +160,31 @@ ValidatingWebhookConfiguration describes the configuration of and admission webh
<a name="RuleWithOperations"></a>
*RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.*
- **webhooks.rules.apiGroups** ([]string)
- **webhooks.rules.apiGroups** ([]string)
APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.
- **webhooks.rules.apiVersions** ([]string)
- **webhooks.rules.apiVersions** ([]string)
APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.
- **webhooks.rules.operations** ([]string)
- **webhooks.rules.operations** ([]string)
Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required.
- **webhooks.rules.resources** ([]string)
- **webhooks.rules.resources** ([]string)
Resources is a list of resources this rule applies to.
For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources.
If wildcard is present, the validation rule will ensure resources do not overlap with each other.
Depending on the enclosing object, subresources might not be allowed. Required.
Resources is a list of resources this rule applies to.
For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources.
If wildcard is present, the validation rule will ensure resources do not overlap with each other.
Depending on the enclosing object, subresources might not be allowed. Required.
- **webhooks.rules.scope** (string)
- **webhooks.rules.scope** (string)
scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*".
- **webhooks.timeoutSeconds** (int32)

4
content/en/docs/reference/kubernetes-api/policies-resources/_index.md Normal file
View File

@ -0,0 +1,4 @@
---
title: "Policies Resources"
weight: 6
---

28
content/en/docs/reference/kubernetes-api/policy-resources/limit-range-v1.md → content/en/docs/reference/kubernetes-api/policies-resources/limit-range-v1.md
View File

@ -30,7 +30,7 @@ LimitRange sets resource usage limits for each kind of resource in a Namespace.
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../policy-resources/limit-range-v1#LimitRangeSpec" >}}">LimitRangeSpec</a>)
- **spec** (<a href="{{< ref "../policies-resources/limit-range-v1#LimitRangeSpec" >}}">LimitRangeSpec</a>)
Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@ -95,9 +95,9 @@ LimitRangeList is a list of LimitRange items.
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="{{< ref "../policy-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>), required
- **items** ([]<a href="{{< ref "../policies-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>), required
Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
@ -142,7 +142,7 @@ GET /api/v1/namespaces/{namespace}/limitranges/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>): OK
200 (<a href="{{< ref "../policies-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>): OK
401: Unauthorized
@ -215,7 +215,7 @@ GET /api/v1/namespaces/{namespace}/limitranges
#### Response
200 (<a href="{{< ref "../policy-resources/limit-range-v1#LimitRangeList" >}}">LimitRangeList</a>): OK
200 (<a href="{{< ref "../policies-resources/limit-range-v1#LimitRangeList" >}}">LimitRangeList</a>): OK
401: Unauthorized
@ -283,7 +283,7 @@ GET /api/v1/limitranges
#### Response
200 (<a href="{{< ref "../policy-resources/limit-range-v1#LimitRangeList" >}}">LimitRangeList</a>): OK
200 (<a href="{{< ref "../policies-resources/limit-range-v1#LimitRangeList" >}}">LimitRangeList</a>): OK
401: Unauthorized
@ -302,7 +302,7 @@ POST /api/v1/namespaces/{namespace}/limitranges
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../policy-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>, required
- **body**: <a href="{{< ref "../policies-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>, required
@ -326,11 +326,11 @@ POST /api/v1/namespaces/{namespace}/limitranges
#### Response
200 (<a href="{{< ref "../policy-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>): OK
200 (<a href="{{< ref "../policies-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>): OK
201 (<a href="{{< ref "../policy-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>): Created
201 (<a href="{{< ref "../policies-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>): Created
202 (<a href="{{< ref "../policy-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>): Accepted
202 (<a href="{{< ref "../policies-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>): Accepted
401: Unauthorized
@ -354,7 +354,7 @@ PUT /api/v1/namespaces/{namespace}/limitranges/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../policy-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>, required
- **body**: <a href="{{< ref "../policies-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>, required
@ -378,9 +378,9 @@ PUT /api/v1/namespaces/{namespace}/limitranges/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>): OK
200 (<a href="{{< ref "../policies-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>): OK
201 (<a href="{{< ref "../policy-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>): Created
201 (<a href="{{< ref "../policies-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>): Created
401: Unauthorized
@ -433,7 +433,7 @@ PATCH /api/v1/namespaces/{namespace}/limitranges/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>): OK
200 (<a href="{{< ref "../policies-resources/limit-range-v1#LimitRange" >}}">LimitRange</a>): OK
401: Unauthorized

124
content/en/docs/reference/kubernetes-api/policy-resources/network-policy-v1.md → content/en/docs/reference/kubernetes-api/policies-resources/network-policy-v1.md
View File

@ -30,7 +30,7 @@ NetworkPolicy describes what network traffic is allowed for a set of Pods
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicySpec" >}}">NetworkPolicySpec</a>)
- **spec** (<a href="{{< ref "../policies-resources/network-policy-v1#NetworkPolicySpec" >}}">NetworkPolicySpec</a>)
Specification of the desired behavior for this NetworkPolicy.
@ -50,7 +50,7 @@ NetworkPolicySpec provides the specification of a NetworkPolicy
- **policyTypes** ([]string)
List of rule types that the NetworkPolicy relates to. Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"]. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8
List of rule types that the NetworkPolicy relates to. Valid options are "Ingress", "Egress", or "Ingress,Egress". If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8
- **ingress** ([]NetworkPolicyIngressRule)
@ -66,32 +66,32 @@ NetworkPolicySpec provides the specification of a NetworkPolicy
<a name="NetworkPolicyPeer"></a>
*NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed*
- **ingress.from.ipBlock** (IPBlock)
- **ingress.from.ipBlock** (IPBlock)
IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.
IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.
<a name="IPBlock"></a>
*IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.*
<a name="IPBlock"></a>
*IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.*
- **ingress.from.ipBlock.cidr** (string), required
- **ingress.from.ipBlock.cidr** (string), required
CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64"
CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64"
- **ingress.from.ipBlock.except** ([]string)
- **ingress.from.ipBlock.except** ([]string)
Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range
Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range
- **ingress.from.namespaceSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
- **ingress.from.namespaceSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.
If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.
Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.
If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.
- **ingress.from.podSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
- **ingress.from.podSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods.
If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.
This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods.
If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.
- **ingress.ports** ([]NetworkPolicyPort)
@ -100,20 +100,16 @@ NetworkPolicySpec provides the specification of a NetworkPolicy
<a name="NetworkPolicyPort"></a>
*NetworkPolicyPort describes a port to allow traffic on*
- **ingress.ports.port** (IntOrString)
- **ingress.ports.port** (IntOrString)
The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.
The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **ingress.ports.endPort** (int32)
- **ingress.ports.protocol** (string)
If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port. This feature is in Alpha state and should be enabled using the Feature Gate "NetworkPolicyEndPort".
- **ingress.ports.protocol** (string)
The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
- **egress** ([]NetworkPolicyEgressRule)
@ -129,32 +125,32 @@ NetworkPolicySpec provides the specification of a NetworkPolicy
<a name="NetworkPolicyPeer"></a>
*NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed*
- **egress.to.ipBlock** (IPBlock)
- **egress.to.ipBlock** (IPBlock)
IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.
IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.
<a name="IPBlock"></a>
*IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.*
<a name="IPBlock"></a>
*IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.*
- **egress.to.ipBlock.cidr** (string), required
- **egress.to.ipBlock.cidr** (string), required
CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64"
CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64"
- **egress.to.ipBlock.except** ([]string)
- **egress.to.ipBlock.except** ([]string)
Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range
Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range
- **egress.to.namespaceSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
- **egress.to.namespaceSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.
If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.
Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.
If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.
- **egress.to.podSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
- **egress.to.podSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods.
If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.
This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods.
If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.
- **egress.ports** ([]NetworkPolicyPort)
@ -163,20 +159,16 @@ NetworkPolicySpec provides the specification of a NetworkPolicy
<a name="NetworkPolicyPort"></a>
*NetworkPolicyPort describes a port to allow traffic on*
- **egress.ports.port** (IntOrString)
- **egress.ports.port** (IntOrString)
The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.
The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **egress.ports.endPort** (int32)
- **egress.ports.protocol** (string)
If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port. This feature is in Alpha state and should be enabled using the Feature Gate "NetworkPolicyEndPort".
- **egress.ports.protocol** (string)
The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
@ -198,7 +190,7 @@ NetworkPolicyList is a list of NetworkPolicy objects.
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>), required
- **items** ([]<a href="{{< ref "../policies-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>), required
Items is a list of schema objects.
@ -245,7 +237,7 @@ GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): OK
200 (<a href="{{< ref "../policies-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): OK
401: Unauthorized
@ -318,7 +310,7 @@ GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
#### Response
200 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicyList" >}}">NetworkPolicyList</a>): OK
200 (<a href="{{< ref "../policies-resources/network-policy-v1#NetworkPolicyList" >}}">NetworkPolicyList</a>): OK
401: Unauthorized
@ -386,7 +378,7 @@ GET /apis/networking.k8s.io/v1/networkpolicies
#### Response
200 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicyList" >}}">NetworkPolicyList</a>): OK
200 (<a href="{{< ref "../policies-resources/network-policy-v1#NetworkPolicyList" >}}">NetworkPolicyList</a>): OK
401: Unauthorized
@ -405,7 +397,7 @@ POST /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>, required
- **body**: <a href="{{< ref "../policies-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>, required
@ -429,11 +421,11 @@ POST /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
#### Response
200 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): OK
200 (<a href="{{< ref "../policies-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): OK
201 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): Created
201 (<a href="{{< ref "../policies-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): Created
202 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): Accepted
202 (<a href="{{< ref "../policies-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): Accepted
401: Unauthorized
@ -457,7 +449,7 @@ PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>, required
- **body**: <a href="{{< ref "../policies-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>, required
@ -481,9 +473,9 @@ PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): OK
200 (<a href="{{< ref "../policies-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): OK
201 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): Created
201 (<a href="{{< ref "../policies-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): Created
401: Unauthorized
@ -536,7 +528,7 @@ PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): OK
200 (<a href="{{< ref "../policies-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>): OK
401: Unauthorized

125
content/en/docs/reference/kubernetes-api/policy-resources/pod-disruption-budget-v1.md → content/en/docs/reference/kubernetes-api/policies-resources/pod-disruption-budget-v1beta1.md
View File

@ -1,17 +1,17 @@
---
api_metadata:
apiVersion: "policy/v1"
import: "k8s.io/api/policy/v1"
apiVersion: "policy/v1beta1"
import: "k8s.io/api/policy/v1beta1"
kind: "PodDisruptionBudget"
content_type: "api_reference"
description: "PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods."
title: "PodDisruptionBudget"
title: "PodDisruptionBudget v1beta1"
weight: 4
---
`apiVersion: policy/v1`
`apiVersion: policy/v1beta1`
`import "k8s.io/api/policy/v1"`
`import "k8s.io/api/policy/v1beta1"`
## PodDisruptionBudget {#PodDisruptionBudget}
@ -20,7 +20,7 @@ PodDisruptionBudget is an object to define the max disruption that can be caused
<hr>
- **apiVersion**: policy/v1
- **apiVersion**: policy/v1beta1
- **kind**: PodDisruptionBudget
@ -28,13 +28,12 @@ PodDisruptionBudget is an object to define the max disruption that can be caused
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudgetSpec" >}}">PodDisruptionBudgetSpec</a>)
- **spec** (<a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudgetSpec" >}}">PodDisruptionBudgetSpec</a>)
Specification of the desired behavior of the PodDisruptionBudget.
- **status** (<a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudgetStatus" >}}">PodDisruptionBudgetStatus</a>)
- **status** (<a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudgetStatus" >}}">PodDisruptionBudgetStatus</a>)
Most recently observed status of the PodDisruptionBudget.
@ -64,7 +63,7 @@ PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.
- **selector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
Label query over pods whose evictions are managed by the disruption budget. A null selector will match no pods, while an empty ({}) selector will select all pods within the namespace.
Label query over pods whose evictions are managed by the disruption budget.
@ -92,52 +91,6 @@ PodDisruptionBudgetStatus represents information about the status of a PodDisrup
total number of pods counted by this disruption budget
- **conditions** ([]Condition)
*Patch strategy: merge on key `type`*
*Map: unique values on key type will be kept during a merge*
Conditions contain conditions for PDB. The disruption controller sets the DisruptionAllowed condition. The following are known values for the reason field (additional reasons could be added in the future): - SyncFailed: The controller encountered an error and wasn't able to compute
the number of allowed disruptions. Therefore no disruptions are
allowed and the status of the condition will be False.
- InsufficientPods: The number of pods are either at or below the number
required by the PodDisruptionBudget. No disruptions are
allowed and the status of the condition will be False.
- SufficientPods: There are more pods than required by the PodDisruptionBudget.
The condition will be True, and the number of allowed
disruptions are provided by the disruptionsAllowed property.
<a name="Condition"></a>
*Condition contains details for one aspect of the current state of this API Resource.*
- **conditions.lastTransitionTime** (Time), required
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **conditions.message** (string), required
message is a human readable message indicating details about the transition. This may be an empty string.
- **conditions.reason** (string), required
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
- **conditions.status** (string), required
status of the condition, one of True, False, Unknown.
- **conditions.type** (string), required
type of condition in CamelCase or in foo.example.com/CamelCase.
- **conditions.observedGeneration** (int64)
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
- **disruptedPods** (map[string]Time)
DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
@ -159,7 +112,7 @@ PodDisruptionBudgetList is a collection of PodDisruptionBudgets.
<hr>
- **apiVersion**: policy/v1
- **apiVersion**: policy/v1beta1
- **kind**: PodDisruptionBudgetList
@ -167,11 +120,9 @@ PodDisruptionBudgetList is a collection of PodDisruptionBudgets.
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>), required
- **items** ([]<a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>), required
Items is a list of PodDisruptionBudgets
@ -192,7 +143,7 @@ PodDisruptionBudgetList is a collection of PodDisruptionBudgets.
#### HTTP Request
GET /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}
#### Parameters
@ -216,7 +167,7 @@ GET /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): OK
200 (<a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): OK
401: Unauthorized
@ -225,7 +176,7 @@ GET /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
#### HTTP Request
GET /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
#### Parameters
@ -249,7 +200,7 @@ GET /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
#### Response
200 (<a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): OK
200 (<a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): OK
401: Unauthorized
@ -258,7 +209,7 @@ GET /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
#### HTTP Request
GET /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets
GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets
#### Parameters
@ -322,7 +273,7 @@ GET /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets
#### Response
200 (<a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudgetList" >}}">PodDisruptionBudgetList</a>): OK
200 (<a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudgetList" >}}">PodDisruptionBudgetList</a>): OK
401: Unauthorized
@ -331,7 +282,7 @@ GET /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets
#### HTTP Request
GET /apis/policy/v1/poddisruptionbudgets
GET /apis/policy/v1beta1/poddisruptionbudgets
#### Parameters
@ -390,7 +341,7 @@ GET /apis/policy/v1/poddisruptionbudgets
#### Response
200 (<a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudgetList" >}}">PodDisruptionBudgetList</a>): OK
200 (<a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudgetList" >}}">PodDisruptionBudgetList</a>): OK
401: Unauthorized
@ -399,7 +350,7 @@ GET /apis/policy/v1/poddisruptionbudgets
#### HTTP Request
POST /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets
POST /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets
#### Parameters
@ -409,7 +360,7 @@ POST /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>, required
- **body**: <a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>, required
@ -433,11 +384,11 @@ POST /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets
#### Response
200 (<a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): OK
200 (<a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): OK
201 (<a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): Created
201 (<a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): Created
202 (<a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): Accepted
202 (<a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): Accepted
401: Unauthorized
@ -446,7 +397,7 @@ POST /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets
#### HTTP Request
PUT /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}
#### Parameters
@ -461,7 +412,7 @@ PUT /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>, required
- **body**: <a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>, required
@ -485,9 +436,9 @@ PUT /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): OK
200 (<a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): OK
201 (<a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): Created
201 (<a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): Created
401: Unauthorized
@ -496,7 +447,7 @@ PUT /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
#### HTTP Request
PUT /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
#### Parameters
@ -511,7 +462,7 @@ PUT /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>, required
- **body**: <a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>, required
@ -535,9 +486,9 @@ PUT /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
#### Response
200 (<a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): OK
200 (<a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): OK
201 (<a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): Created
201 (<a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): Created
401: Unauthorized
@ -546,7 +497,7 @@ PUT /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
#### HTTP Request
PATCH /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}
#### Parameters
@ -590,7 +541,7 @@ PATCH /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): OK
200 (<a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): OK
401: Unauthorized
@ -599,7 +550,7 @@ PATCH /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
#### HTTP Request
PATCH /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
#### Parameters
@ -643,7 +594,7 @@ PATCH /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
#### Response
200 (<a href="{{< ref "../policy-resources/pod-disruption-budget-v1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): OK
200 (<a href="{{< ref "../policies-resources/pod-disruption-budget-v1beta1#PodDisruptionBudget" >}}">PodDisruptionBudget</a>): OK
401: Unauthorized
@ -652,7 +603,7 @@ PATCH /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
#### HTTP Request
DELETE /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}
#### Parameters
@ -707,7 +658,7 @@ DELETE /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}
#### HTTP Request
DELETE /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets
DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets
#### Parameters

78
content/en/docs/reference/kubernetes-api/policy-resources/pod-security-policy-v1beta1.md → content/en/docs/reference/kubernetes-api/policies-resources/pod-security-policy-v1beta1.md
View File

@ -16,7 +16,7 @@ weight: 5
## PodSecurityPolicy {#PodSecurityPolicy}
PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container. Deprecated in 1.21.
PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container.
<hr>
@ -30,7 +30,7 @@ PodSecurityPolicy governs the ability to make requests that affect the Security
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../policy-resources/pod-security-policy-v1beta1#PodSecurityPolicySpec" >}}">PodSecurityPolicySpec</a>)
- **spec** (<a href="{{< ref "../policies-resources/pod-security-policy-v1beta1#PodSecurityPolicySpec" >}}">PodSecurityPolicySpec</a>)
spec defines the policy enforced.
@ -62,13 +62,13 @@ PodSecurityPolicySpec defines the policy enforced.
<a name="IDRange"></a>
*IDRange provides a min/max of an allowed range of IDs.*
- **runAsUser.ranges.max** (int64), required
- **runAsUser.ranges.max** (int64), required
max is the end of the range, inclusive.
max is the end of the range, inclusive.
- **runAsUser.ranges.min** (int64), required
- **runAsUser.ranges.min** (int64), required
min is the start of the range, inclusive.
min is the start of the range, inclusive.
- **runAsGroup** (RunAsGroupStrategyOptions)
@ -88,13 +88,13 @@ PodSecurityPolicySpec defines the policy enforced.
<a name="IDRange"></a>
*IDRange provides a min/max of an allowed range of IDs.*
- **runAsGroup.ranges.max** (int64), required
- **runAsGroup.ranges.max** (int64), required
max is the end of the range, inclusive.
max is the end of the range, inclusive.
- **runAsGroup.ranges.min** (int64), required
- **runAsGroup.ranges.min** (int64), required
min is the start of the range, inclusive.
min is the start of the range, inclusive.
- **fsGroup** (FSGroupStrategyOptions), required
@ -110,13 +110,13 @@ PodSecurityPolicySpec defines the policy enforced.
<a name="IDRange"></a>
*IDRange provides a min/max of an allowed range of IDs.*
- **fsGroup.ranges.max** (int64), required
- **fsGroup.ranges.max** (int64), required
max is the end of the range, inclusive.
max is the end of the range, inclusive.
- **fsGroup.ranges.min** (int64), required
- **fsGroup.ranges.min** (int64), required
min is the start of the range, inclusive.
min is the start of the range, inclusive.
- **fsGroup.rule** (string)
@ -136,13 +136,13 @@ PodSecurityPolicySpec defines the policy enforced.
<a name="IDRange"></a>
*IDRange provides a min/max of an allowed range of IDs.*
- **supplementalGroups.ranges.max** (int64), required
- **supplementalGroups.ranges.max** (int64), required
max is the end of the range, inclusive.
max is the end of the range, inclusive.
- **supplementalGroups.ranges.min** (int64), required
- **supplementalGroups.ranges.min** (int64), required
min is the start of the range, inclusive.
min is the start of the range, inclusive.
- **supplementalGroups.rule** (string)
@ -166,21 +166,21 @@ PodSecurityPolicySpec defines the policy enforced.
<a name="SELinuxOptions"></a>
*SELinuxOptions are the labels to be applied to the container*
- **seLinux.seLinuxOptions.level** (string)
- **seLinux.seLinuxOptions.level** (string)
Level is SELinux level label that applies to the container.
Level is SELinux level label that applies to the container.
- **seLinux.seLinuxOptions.role** (string)
- **seLinux.seLinuxOptions.role** (string)
Role is a SELinux role label that applies to the container.
Role is a SELinux role label that applies to the container.
- **seLinux.seLinuxOptions.type** (string)
- **seLinux.seLinuxOptions.type** (string)
Type is a SELinux type label that applies to the container.
Type is a SELinux type label that applies to the container.
- **seLinux.seLinuxOptions.user** (string)
- **seLinux.seLinuxOptions.user** (string)
User is a SELinux user label that applies to the container.
User is a SELinux user label that applies to the container.
- **readOnlyRootFilesystem** (boolean)
@ -331,7 +331,7 @@ PodSecurityPolicyList is a list of PodSecurityPolicy objects.
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="{{< ref "../policy-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>), required
- **items** ([]<a href="{{< ref "../policies-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>), required
items is a list of schema objects.
@ -373,7 +373,7 @@ GET /apis/policy/v1beta1/podsecuritypolicies/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): OK
200 (<a href="{{< ref "../policies-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): OK
401: Unauthorized
@ -441,7 +441,7 @@ GET /apis/policy/v1beta1/podsecuritypolicies
#### Response
200 (<a href="{{< ref "../policy-resources/pod-security-policy-v1beta1#PodSecurityPolicyList" >}}">PodSecurityPolicyList</a>): OK
200 (<a href="{{< ref "../policies-resources/pod-security-policy-v1beta1#PodSecurityPolicyList" >}}">PodSecurityPolicyList</a>): OK
401: Unauthorized
@ -455,7 +455,7 @@ POST /apis/policy/v1beta1/podsecuritypolicies
#### Parameters
- **body**: <a href="{{< ref "../policy-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>, required
- **body**: <a href="{{< ref "../policies-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>, required
@ -479,11 +479,11 @@ POST /apis/policy/v1beta1/podsecuritypolicies
#### Response
200 (<a href="{{< ref "../policy-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): OK
200 (<a href="{{< ref "../policies-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): OK
201 (<a href="{{< ref "../policy-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): Created
201 (<a href="{{< ref "../policies-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): Created
202 (<a href="{{< ref "../policy-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): Accepted
202 (<a href="{{< ref "../policies-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): Accepted
401: Unauthorized
@ -502,7 +502,7 @@ PUT /apis/policy/v1beta1/podsecuritypolicies/{name}
name of the PodSecurityPolicy
- **body**: <a href="{{< ref "../policy-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>, required
- **body**: <a href="{{< ref "../policies-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>, required
@ -526,9 +526,9 @@ PUT /apis/policy/v1beta1/podsecuritypolicies/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): OK
200 (<a href="{{< ref "../policies-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): OK
201 (<a href="{{< ref "../policy-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): Created
201 (<a href="{{< ref "../policies-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): Created
401: Unauthorized
@ -576,7 +576,7 @@ PATCH /apis/policy/v1beta1/podsecuritypolicies/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): OK
200 (<a href="{{< ref "../policies-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): OK
401: Unauthorized
@ -624,9 +624,9 @@ DELETE /apis/policy/v1beta1/podsecuritypolicies/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): OK
200 (<a href="{{< ref "../policies-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): OK
202 (<a href="{{< ref "../policy-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): Accepted
202 (<a href="{{< ref "../policies-resources/pod-security-policy-v1beta1#PodSecurityPolicy" >}}">PodSecurityPolicy</a>): Accepted
401: Unauthorized

54
content/en/docs/reference/kubernetes-api/policy-resources/resource-quota-v1.md → content/en/docs/reference/kubernetes-api/policies-resources/resource-quota-v1.md
View File

@ -30,11 +30,11 @@ ResourceQuota sets aggregate quota restrictions enforced per namespace
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuotaSpec" >}}">ResourceQuotaSpec</a>)
- **spec** (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuotaSpec" >}}">ResourceQuotaSpec</a>)
Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuotaStatus" >}}">ResourceQuotaStatus</a>)
- **status** (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuotaStatus" >}}">ResourceQuotaStatus</a>)
Status defines the actual enforced quota and its current usage. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@ -66,17 +66,17 @@ ResourceQuotaSpec defines the desired hard limits to enforce for Quota.
<a name="ScopedResourceSelectorRequirement"></a>
*A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.*
- **scopeSelector.matchExpressions.operator** (string), required
- **scopeSelector.matchExpressions.operator** (string), required
Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
- **scopeSelector.matchExpressions.scopeName** (string), required
- **scopeSelector.matchExpressions.scopeName** (string), required
The name of the scope that the selector applies to.
The name of the scope that the selector applies to.
- **scopeSelector.matchExpressions.values** ([]string)
- **scopeSelector.matchExpressions.values** ([]string)
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.
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.
- **scopes** ([]string)
@ -120,7 +120,7 @@ ResourceQuotaList is a list of ResourceQuota items.
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>), required
- **items** ([]<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>), required
Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
@ -167,7 +167,7 @@ GET /api/v1/namespaces/{namespace}/resourcequotas/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): OK
200 (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): OK
401: Unauthorized
@ -200,7 +200,7 @@ GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
#### Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): OK
200 (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): OK
401: Unauthorized
@ -273,7 +273,7 @@ GET /api/v1/namespaces/{namespace}/resourcequotas
#### Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuotaList" >}}">ResourceQuotaList</a>): OK
200 (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuotaList" >}}">ResourceQuotaList</a>): OK
401: Unauthorized
@ -341,7 +341,7 @@ GET /api/v1/resourcequotas
#### Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuotaList" >}}">ResourceQuotaList</a>): OK
200 (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuotaList" >}}">ResourceQuotaList</a>): OK
401: Unauthorized
@ -360,7 +360,7 @@ POST /api/v1/namespaces/{namespace}/resourcequotas
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>, required
- **body**: <a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>, required
@ -384,11 +384,11 @@ POST /api/v1/namespaces/{namespace}/resourcequotas
#### Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): OK
200 (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): OK
201 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): Created
201 (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): Created
202 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): Accepted
202 (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): Accepted
401: Unauthorized
@ -412,7 +412,7 @@ PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>, required
- **body**: <a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>, required
@ -436,9 +436,9 @@ PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): OK
200 (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): OK
201 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): Created
201 (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): Created
401: Unauthorized
@ -462,7 +462,7 @@ PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>, required
- **body**: <a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>, required
@ -486,9 +486,9 @@ PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
#### Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): OK
200 (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): OK
201 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): Created
201 (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): Created
401: Unauthorized
@ -541,7 +541,7 @@ PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): OK
200 (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): OK
401: Unauthorized
@ -594,7 +594,7 @@ PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
#### Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): OK
200 (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): OK
401: Unauthorized
@ -647,9 +647,9 @@ DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}
#### Response
200 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): OK
200 (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): OK
202 (<a href="{{< ref "../policy-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): Accepted
202 (<a href="{{< ref "../policies-resources/resource-quota-v1#ResourceQuota" >}}">ResourceQuota</a>): Accepted
401: Unauthorized

4
content/en/docs/reference/kubernetes-api/policy-resources/_index.md
View File

@ -1,4 +0,0 @@
---
title: "Policy Resources"
weight: 6
---

4
content/en/docs/reference/kubernetes-api/service-resources/_index.md
View File

@ -1,4 +0,0 @@
---
title: "Service Resources"
weight: 2
---

4
content/en/docs/reference/kubernetes-api/services-resources/_index.md Normal file
View File

@ -0,0 +1,4 @@
---
title: "Services Resources"
weight: 2
---

101
content/en/docs/reference/kubernetes-api/service-resources/endpoint-slice-v1.md → content/en/docs/reference/kubernetes-api/services-resources/endpoint-slice-v1beta1.md
View File

@ -1,17 +1,17 @@
---
api_metadata:
apiVersion: "discovery.k8s.io/v1"
import: "k8s.io/api/discovery/v1"
apiVersion: "discovery.k8s.io/v1beta1"
import: "k8s.io/api/discovery/v1beta1"
kind: "EndpointSlice"
content_type: "api_reference"
description: "EndpointSlice represents a subset of the endpoints that implement a service."
title: "EndpointSlice"
title: "EndpointSlice v1beta1"
weight: 3
---
`apiVersion: discovery.k8s.io/v1`
`apiVersion: discovery.k8s.io/v1beta1`
`import "k8s.io/api/discovery/v1"`
`import "k8s.io/api/discovery/v1beta1"`
## EndpointSlice {#EndpointSlice}
@ -20,7 +20,7 @@ EndpointSlice represents a subset of the endpoints that implement a service. For
<hr>
- **apiVersion**: discovery.k8s.io/v1
- **apiVersion**: discovery.k8s.io/v1beta1
- **kind**: EndpointSlice
@ -56,41 +56,17 @@ EndpointSlice represents a subset of the endpoints that implement a service. For
<a name="EndpointConditions"></a>
*EndpointConditions represents the current condition of an endpoint.*
- **endpoints.conditions.ready** (boolean)
- **endpoints.conditions.ready** (boolean)
ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be "true" for terminating endpoints.
ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be "true" for terminating endpoints.
- **endpoints.conditions.serving** (boolean)
- **endpoints.conditions.serving** (boolean)
serving is identical to ready except that it is set regardless of the terminating state of endpoints. This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.
serving is identical to ready except that it is set regardless of the terminating state of endpoints. This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.
- **endpoints.conditions.terminating** (boolean)
- **endpoints.conditions.terminating** (boolean)
terminating indicates that this endpoint is terminating. A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.
- **endpoints.deprecatedTopology** (map[string]string)
deprecatedTopology contains topology information part of the v1beta1 API. This field is deprecated, and will be removed when the v1beta1 API is removed (no sooner than kubernetes v1.24). While this field can hold values, it is not writable through the v1 API, and any attempts to write to it will be silently ignored. Topology information can be found in the zone and nodeName fields instead.
- **endpoints.hints** (EndpointHints)
hints contains information associated with how an endpoint should be consumed.
<a name="EndpointHints"></a>
*EndpointHints provides hints describing how an endpoint should be consumed.*
- **endpoints.hints.forZones** ([]ForZone)
*Atomic: will be replaced during a merge*
forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing.
<a name="ForZone"></a>
*ForZone provides information about which zones should consume this endpoint.*
- **endpoints.hints.forZones.name** (string), required
name represents the name of the zone.
terminating indicates that this endpoint is terminating. A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating. This field can be enabled with the EndpointSliceTerminatingCondition feature gate.
- **endpoints.hostname** (string)
@ -104,9 +80,16 @@ EndpointSlice represents a subset of the endpoints that implement a service. For
targetRef is a reference to a Kubernetes object that represents this endpoint.
- **endpoints.zone** (string)
- **endpoints.topology** (map[string]string)
zone is the name of the Zone this endpoint exists in.
topology contains arbitrary topology information associated with the endpoint. These key/value pairs must conform with the label format. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Topology may include a maximum of 16 key/value pairs. This includes, but is not limited to the following well known keys: * kubernetes.io/hostname: the value indicates the hostname of the node
where the endpoint is located. This should match the corresponding
node label.
* topology.kubernetes.io/zone: the value indicates the zone where the
endpoint is located. This should match the corresponding node label.
* topology.kubernetes.io/region: the value indicates the region where the
endpoint is located. This should match the corresponding node label.
This field is deprecated and will be removed in future api versions.
- **ports** ([]EndpointPort)
@ -143,7 +126,7 @@ EndpointSliceList represents a list of endpoint slices
<hr>
- **apiVersion**: discovery.k8s.io/v1
- **apiVersion**: discovery.k8s.io/v1beta1
- **kind**: EndpointSliceList
@ -153,7 +136,7 @@ EndpointSliceList represents a list of endpoint slices
Standard list metadata.
- **items** ([]<a href="{{< ref "../service-resources/endpoint-slice-v1#EndpointSlice" >}}">EndpointSlice</a>), required
- **items** ([]<a href="{{< ref "../services-resources/endpoint-slice-v1beta1#EndpointSlice" >}}">EndpointSlice</a>), required
List of endpoint slices
@ -176,7 +159,7 @@ EndpointSliceList represents a list of endpoint slices
#### HTTP Request
GET /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
GET /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name}
#### Parameters
@ -200,7 +183,7 @@ GET /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
#### Response
200 (<a href="{{< ref "../service-resources/endpoint-slice-v1#EndpointSlice" >}}">EndpointSlice</a>): OK
200 (<a href="{{< ref "../services-resources/endpoint-slice-v1beta1#EndpointSlice" >}}">EndpointSlice</a>): OK
401: Unauthorized
@ -209,7 +192,7 @@ GET /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
#### HTTP Request
GET /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices
GET /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices
#### Parameters
@ -273,7 +256,7 @@ GET /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices
#### Response
200 (<a href="{{< ref "../service-resources/endpoint-slice-v1#EndpointSliceList" >}}">EndpointSliceList</a>): OK
200 (<a href="{{< ref "../services-resources/endpoint-slice-v1beta1#EndpointSliceList" >}}">EndpointSliceList</a>): OK
401: Unauthorized
@ -282,7 +265,7 @@ GET /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices
#### HTTP Request
GET /apis/discovery.k8s.io/v1/endpointslices
GET /apis/discovery.k8s.io/v1beta1/endpointslices
#### Parameters
@ -341,7 +324,7 @@ GET /apis/discovery.k8s.io/v1/endpointslices
#### Response
200 (<a href="{{< ref "../service-resources/endpoint-slice-v1#EndpointSliceList" >}}">EndpointSliceList</a>): OK
200 (<a href="{{< ref "../services-resources/endpoint-slice-v1beta1#EndpointSliceList" >}}">EndpointSliceList</a>): OK
401: Unauthorized
@ -350,7 +333,7 @@ GET /apis/discovery.k8s.io/v1/endpointslices
#### HTTP Request
POST /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices
POST /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices
#### Parameters
@ -360,7 +343,7 @@ POST /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../service-resources/endpoint-slice-v1#EndpointSlice" >}}">EndpointSlice</a>, required
- **body**: <a href="{{< ref "../services-resources/endpoint-slice-v1beta1#EndpointSlice" >}}">EndpointSlice</a>, required
@ -384,11 +367,11 @@ POST /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices
#### Response
200 (<a href="{{< ref "../service-resources/endpoint-slice-v1#EndpointSlice" >}}">EndpointSlice</a>): OK
200 (<a href="{{< ref "../services-resources/endpoint-slice-v1beta1#EndpointSlice" >}}">EndpointSlice</a>): OK
201 (<a href="{{< ref "../service-resources/endpoint-slice-v1#EndpointSlice" >}}">EndpointSlice</a>): Created
201 (<a href="{{< ref "../services-resources/endpoint-slice-v1beta1#EndpointSlice" >}}">EndpointSlice</a>): Created
202 (<a href="{{< ref "../service-resources/endpoint-slice-v1#EndpointSlice" >}}">EndpointSlice</a>): Accepted
202 (<a href="{{< ref "../services-resources/endpoint-slice-v1beta1#EndpointSlice" >}}">EndpointSlice</a>): Accepted
401: Unauthorized
@ -397,7 +380,7 @@ POST /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices
#### HTTP Request
PUT /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
PUT /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name}
#### Parameters
@ -412,7 +395,7 @@ PUT /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../service-resources/endpoint-slice-v1#EndpointSlice" >}}">EndpointSlice</a>, required
- **body**: <a href="{{< ref "../services-resources/endpoint-slice-v1beta1#EndpointSlice" >}}">EndpointSlice</a>, required
@ -436,9 +419,9 @@ PUT /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
#### Response
200 (<a href="{{< ref "../service-resources/endpoint-slice-v1#EndpointSlice" >}}">EndpointSlice</a>): OK
200 (<a href="{{< ref "../services-resources/endpoint-slice-v1beta1#EndpointSlice" >}}">EndpointSlice</a>): OK
201 (<a href="{{< ref "../service-resources/endpoint-slice-v1#EndpointSlice" >}}">EndpointSlice</a>): Created
201 (<a href="{{< ref "../services-resources/endpoint-slice-v1beta1#EndpointSlice" >}}">EndpointSlice</a>): Created
401: Unauthorized
@ -447,7 +430,7 @@ PUT /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
#### HTTP Request
PATCH /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
PATCH /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name}
#### Parameters
@ -491,7 +474,7 @@ PATCH /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
#### Response
200 (<a href="{{< ref "../service-resources/endpoint-slice-v1#EndpointSlice" >}}">EndpointSlice</a>): OK
200 (<a href="{{< ref "../services-resources/endpoint-slice-v1beta1#EndpointSlice" >}}">EndpointSlice</a>): OK
401: Unauthorized
@ -500,7 +483,7 @@ PATCH /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
#### HTTP Request
DELETE /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
DELETE /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name}
#### Parameters
@ -555,7 +538,7 @@ DELETE /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name}
#### HTTP Request
DELETE /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices
DELETE /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices
#### Parameters

72
content/en/docs/reference/kubernetes-api/service-resources/endpoints-v1.md → content/en/docs/reference/kubernetes-api/services-resources/endpoints-v1.md
View File

@ -62,21 +62,21 @@ Endpoints is a collection of endpoints that implement the actual service. Exampl
<a name="EndpointAddress"></a>
*EndpointAddress is a tuple that describes single IP address.*
- **subsets.addresses.ip** (string), required
- **subsets.addresses.ip** (string), required
The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready.
The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready.
- **subsets.addresses.hostname** (string)
- **subsets.addresses.hostname** (string)
The Hostname of this endpoint
The Hostname of this endpoint
- **subsets.addresses.nodeName** (string)
- **subsets.addresses.nodeName** (string)
Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
- **subsets.addresses.targetRef** (<a href="{{< ref "../common-definitions/object-reference#ObjectReference" >}}">ObjectReference</a>)
- **subsets.addresses.targetRef** (<a href="{{< ref "../common-definitions/object-reference#ObjectReference" >}}">ObjectReference</a>)
Reference to object providing the endpoint.
Reference to object providing the endpoint.
- **subsets.notReadyAddresses** ([]EndpointAddress)
@ -85,21 +85,21 @@ Endpoints is a collection of endpoints that implement the actual service. Exampl
<a name="EndpointAddress"></a>
*EndpointAddress is a tuple that describes single IP address.*
- **subsets.notReadyAddresses.ip** (string), required
- **subsets.notReadyAddresses.ip** (string), required
The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready.
The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready.
- **subsets.notReadyAddresses.hostname** (string)
- **subsets.notReadyAddresses.hostname** (string)
The Hostname of this endpoint
The Hostname of this endpoint
- **subsets.notReadyAddresses.nodeName** (string)
- **subsets.notReadyAddresses.nodeName** (string)
Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
- **subsets.notReadyAddresses.targetRef** (<a href="{{< ref "../common-definitions/object-reference#ObjectReference" >}}">ObjectReference</a>)
- **subsets.notReadyAddresses.targetRef** (<a href="{{< ref "../common-definitions/object-reference#ObjectReference" >}}">ObjectReference</a>)
Reference to object providing the endpoint.
Reference to object providing the endpoint.
- **subsets.ports** ([]EndpointPort)
@ -108,21 +108,21 @@ Endpoints is a collection of endpoints that implement the actual service. Exampl
<a name="EndpointPort"></a>
*EndpointPort is a tuple that describes a single port.*
- **subsets.ports.port** (int32), required
- **subsets.ports.port** (int32), required
The port number of the endpoint.
The port number of the endpoint.
- **subsets.ports.protocol** (string)
- **subsets.ports.protocol** (string)
The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.
The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.
- **subsets.ports.name** (string)
- **subsets.ports.name** (string)
The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined.
The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined.
- **subsets.ports.appProtocol** (string)
- **subsets.ports.appProtocol** (string)
The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default.
The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default.
@ -144,7 +144,7 @@ EndpointsList is a list of endpoints.
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="{{< ref "../service-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>), required
- **items** ([]<a href="{{< ref "../services-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>), required
List of endpoints.
@ -191,7 +191,7 @@ GET /api/v1/namespaces/{namespace}/endpoints/{name}
#### Response
200 (<a href="{{< ref "../service-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>): OK
200 (<a href="{{< ref "../services-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>): OK
401: Unauthorized
@ -264,7 +264,7 @@ GET /api/v1/namespaces/{namespace}/endpoints
#### Response
200 (<a href="{{< ref "../service-resources/endpoints-v1#EndpointsList" >}}">EndpointsList</a>): OK
200 (<a href="{{< ref "../services-resources/endpoints-v1#EndpointsList" >}}">EndpointsList</a>): OK
401: Unauthorized
@ -332,7 +332,7 @@ GET /api/v1/endpoints
#### Response
200 (<a href="{{< ref "../service-resources/endpoints-v1#EndpointsList" >}}">EndpointsList</a>): OK
200 (<a href="{{< ref "../services-resources/endpoints-v1#EndpointsList" >}}">EndpointsList</a>): OK
401: Unauthorized
@ -351,7 +351,7 @@ POST /api/v1/namespaces/{namespace}/endpoints
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../service-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>, required
- **body**: <a href="{{< ref "../services-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>, required
@ -375,11 +375,11 @@ POST /api/v1/namespaces/{namespace}/endpoints
#### Response
200 (<a href="{{< ref "../service-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>): OK
200 (<a href="{{< ref "../services-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>): OK
201 (<a href="{{< ref "../service-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>): Created
201 (<a href="{{< ref "../services-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>): Created
202 (<a href="{{< ref "../service-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>): Accepted
202 (<a href="{{< ref "../services-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>): Accepted
401: Unauthorized
@ -403,7 +403,7 @@ PUT /api/v1/namespaces/{namespace}/endpoints/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../service-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>, required
- **body**: <a href="{{< ref "../services-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>, required
@ -427,9 +427,9 @@ PUT /api/v1/namespaces/{namespace}/endpoints/{name}
#### Response
200 (<a href="{{< ref "../service-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>): OK
200 (<a href="{{< ref "../services-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>): OK
201 (<a href="{{< ref "../service-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>): Created
201 (<a href="{{< ref "../services-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>): Created
401: Unauthorized
@ -482,7 +482,7 @@ PATCH /api/v1/namespaces/{namespace}/endpoints/{name}
#### Response
200 (<a href="{{< ref "../service-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>): OK
200 (<a href="{{< ref "../services-resources/endpoints-v1#Endpoints" >}}">Endpoints</a>): OK
401: Unauthorized

49
content/en/docs/reference/kubernetes-api/service-resources/ingress-class-v1.md → content/en/docs/reference/kubernetes-api/services-resources/ingress-class-v1.md
View File

@ -30,7 +30,7 @@ IngressClass represents the class of the Ingress, referenced by the Ingress Spec
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../service-resources/ingress-class-v1#IngressClassSpec" >}}">IngressClassSpec</a>)
- **spec** (<a href="{{< ref "../services-resources/ingress-class-v1#IngressClassSpec" >}}">IngressClassSpec</a>)
Spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@ -48,33 +48,10 @@ IngressClassSpec provides information about the class of an Ingress.
Controller refers to the name of the controller that should handle this class. This allows for different "flavors" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. "acme.io/ingress-controller". This field is immutable.
- **parameters** (IngressClassParametersReference)
- **parameters** (<a href="{{< ref "../common-definitions/typed-local-object-reference#TypedLocalObjectReference" >}}">TypedLocalObjectReference</a>)
Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.
<a name="IngressClassParametersReference"></a>
*IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource.*
- **parameters.kind** (string), required
Kind is the type of resource being referenced.
- **parameters.name** (string), required
Name is the name of resource being referenced.
- **parameters.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.
- **parameters.namespace** (string)
Namespace is the namespace of the resource being referenced. This field is required when scope is set to "Namespace" and must be unset when scope is set to "Cluster".
- **parameters.scope** (string)
Scope represents if this refers to a cluster or namespace scoped resource. This may be set to "Cluster" (default) or "Namespace". Field can be enabled with IngressClassNamespacedParams feature gate.
@ -95,7 +72,7 @@ IngressClassList is a collection of IngressClasses.
Standard list metadata.
- **items** ([]<a href="{{< ref "../service-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>), required
- **items** ([]<a href="{{< ref "../services-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>), required
Items is the list of IngressClasses.
@ -137,7 +114,7 @@ GET /apis/networking.k8s.io/v1/ingressclasses/{name}
#### Response
200 (<a href="{{< ref "../service-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>): OK
200 (<a href="{{< ref "../services-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>): OK
401: Unauthorized
@ -205,7 +182,7 @@ GET /apis/networking.k8s.io/v1/ingressclasses
#### Response
200 (<a href="{{< ref "../service-resources/ingress-class-v1#IngressClassList" >}}">IngressClassList</a>): OK
200 (<a href="{{< ref "../services-resources/ingress-class-v1#IngressClassList" >}}">IngressClassList</a>): OK
401: Unauthorized
@ -219,7 +196,7 @@ POST /apis/networking.k8s.io/v1/ingressclasses
#### Parameters
- **body**: <a href="{{< ref "../service-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>, required
- **body**: <a href="{{< ref "../services-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>, required
@ -243,11 +220,11 @@ POST /apis/networking.k8s.io/v1/ingressclasses
#### Response
200 (<a href="{{< ref "../service-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>): OK
200 (<a href="{{< ref "../services-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>): OK
201 (<a href="{{< ref "../service-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>): Created
201 (<a href="{{< ref "../services-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>): Created
202 (<a href="{{< ref "../service-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>): Accepted
202 (<a href="{{< ref "../services-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>): Accepted
401: Unauthorized
@ -266,7 +243,7 @@ PUT /apis/networking.k8s.io/v1/ingressclasses/{name}
name of the IngressClass
- **body**: <a href="{{< ref "../service-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>, required
- **body**: <a href="{{< ref "../services-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>, required
@ -290,9 +267,9 @@ PUT /apis/networking.k8s.io/v1/ingressclasses/{name}
#### Response
200 (<a href="{{< ref "../service-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>): OK
200 (<a href="{{< ref "../services-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>): OK
201 (<a href="{{< ref "../service-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>): Created
201 (<a href="{{< ref "../services-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>): Created
401: Unauthorized
@ -340,7 +317,7 @@ PATCH /apis/networking.k8s.io/v1/ingressclasses/{name}
#### Response
200 (<a href="{{< ref "../service-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>): OK
200 (<a href="{{< ref "../services-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>): OK
401: Unauthorized

240
content/en/docs/reference/kubernetes-api/service-resources/ingress-v1.md → content/en/docs/reference/kubernetes-api/services-resources/ingress-v1.md
View File

@ -30,11 +30,11 @@ Ingress is a collection of rules that allow inbound connections to reach the end
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../service-resources/ingress-v1#IngressSpec" >}}">IngressSpec</a>)
- **spec** (<a href="{{< ref "../services-resources/ingress-v1#IngressSpec" >}}">IngressSpec</a>)
Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="{{< ref "../service-resources/ingress-v1#IngressStatus" >}}">IngressStatus</a>)
- **status** (<a href="{{< ref "../services-resources/ingress-v1#IngressStatus" >}}">IngressStatus</a>)
Status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@ -48,10 +48,43 @@ IngressSpec describes the Ingress the user wishes to exist.
<hr>
- **defaultBackend** (<a href="{{< ref "../service-resources/ingress-v1#IngressBackend" >}}">IngressBackend</a>)
- **defaultBackend** (IngressBackend)
DefaultBackend is the backend that should handle requests that don't match any rule. If Rules are not specified, DefaultBackend must be specified. If DefaultBackend is not set, the handling of requests that do not match any of the rules will be up to the Ingress controller.
<a name="IngressBackend"></a>
*IngressBackend describes all endpoints for a given service and port.*
- **defaultBackend.resource** (<a href="{{< ref "../common-definitions/typed-local-object-reference#TypedLocalObjectReference" >}}">TypedLocalObjectReference</a>)
Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with "Service".
- **defaultBackend.service** (IngressServiceBackend)
Service references a Service as a Backend. This is a mutually exclusive setting with "Resource".
<a name="IngressServiceBackend"></a>
*IngressServiceBackend references a Kubernetes Service as a Backend.*
- **defaultBackend.service.name** (string), required
Name is the referenced service. The service must exist in the same namespace as the Ingress object.
- **defaultBackend.service.port** (ServiceBackendPort)
Port of the referenced service. A port name or port number is required for a IngressServiceBackend.
<a name="ServiceBackendPort"></a>
*ServiceBackendPort is the service port being referenced.*
- **defaultBackend.service.port.name** (string)
Name is the name of the port on the Service. This is a mutually exclusive setting with "Number".
- **defaultBackend.service.port.number** (int32)
Number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name".
- **ingressClassName** (string)
IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation.
@ -82,36 +115,69 @@ IngressSpec describes the Ingress the user wishes to exist.
<a name="HTTPIngressRuleValue"></a>
*HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'.*
- **rules.http.paths** ([]HTTPIngressPath), required
- **rules.http.paths** ([]HTTPIngressPath), required
*Atomic: will be replaced during a merge*
A collection of paths that map requests to backends.
*Atomic: will be replaced during a merge*
A collection of paths that map requests to backends.
<a name="HTTPIngressPath"></a>
*HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.*
<a name="HTTPIngressPath"></a>
*HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.*
- **rules.http.paths.backend** (<a href="{{< ref "../service-resources/ingress-v1#IngressBackend" >}}">IngressBackend</a>), required
- **rules.http.paths.backend** (IngressBackend), required
Backend defines the referenced service endpoint to which the traffic will be forwarded to.
Backend defines the referenced service endpoint to which the traffic will be forwarded to.
- **rules.http.paths.path** (string)
<a name="IngressBackend"></a>
*IngressBackend describes all endpoints for a given service and port.*
Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. When unspecified, all paths from incoming requests are matched.
- **rules.http.paths.backend.resource** (<a href="{{< ref "../common-definitions/typed-local-object-reference#TypedLocalObjectReference" >}}">TypedLocalObjectReference</a>)
- **rules.http.paths.pathType** (string)
Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with "Service".
PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is
done on a path element by element basis. A path element refers is the
list of labels in the path split by the '/' separator. A request is a
match for path p if every p is an element-wise prefix of p of the
request path. Note that if the last element of the path is a substring
of the last element in request path, it is not a match (e.g. /foo/bar
matches /foo/bar/baz, but does not match /foo/barbaz).
* ImplementationSpecific: Interpretation of the Path matching is up to
the IngressClass. Implementations can treat this as a separate PathType
or treat it identically to Prefix or Exact path types.
Implementations are required to support all path types.
- **rules.http.paths.backend.service** (IngressServiceBackend)
Service references a Service as a Backend. This is a mutually exclusive setting with "Resource".
<a name="IngressServiceBackend"></a>
*IngressServiceBackend references a Kubernetes Service as a Backend.*
- **rules.http.paths.backend.service.name** (string), required
Name is the referenced service. The service must exist in the same namespace as the Ingress object.
- **rules.http.paths.backend.service.port** (ServiceBackendPort)
Port of the referenced service. A port name or port number is required for a IngressServiceBackend.
<a name="ServiceBackendPort"></a>
*ServiceBackendPort is the service port being referenced.*
- **rules.http.paths.backend.service.port.name** (string)
Name is the name of the port on the Service. This is a mutually exclusive setting with "Number".
- **rules.http.paths.backend.service.port.number** (int32)
Number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name".
- **rules.http.paths.path** (string)
Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. When unspecified, all paths from incoming requests are matched.
- **rules.http.paths.pathType** (string)
PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is
done on a path element by element basis. A path element refers is the
list of labels in the path split by the '/' separator. A request is a
match for path p if every p is an element-wise prefix of p of the
request path. Note that if the last element of the path is a substring
of the last element in request path, it is not a match (e.g. /foo/bar
matches /foo/bar/baz, but does not match /foo/barbaz).
* ImplementationSpecific: Interpretation of the Path matching is up to
the IngressClass. Implementations can treat this as a separate PathType
or treat it identically to Prefix or Exact path types.
Implementations are required to support all path types.
- **tls** ([]IngressTLS)
@ -136,46 +202,6 @@ IngressSpec describes the Ingress the user wishes to exist.
## IngressBackend {#IngressBackend}
IngressBackend describes all endpoints for a given service and port.
<hr>
- **resource** (<a href="{{< ref "../common-definitions/typed-local-object-reference#TypedLocalObjectReference" >}}">TypedLocalObjectReference</a>)
Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with "Service".
- **service** (IngressServiceBackend)
Service references a Service as a Backend. This is a mutually exclusive setting with "Resource".
<a name="IngressServiceBackend"></a>
*IngressServiceBackend references a Kubernetes Service as a Backend.*
- **service.name** (string), required
Name is the referenced service. The service must exist in the same namespace as the Ingress object.
- **service.port** (ServiceBackendPort)
Port of the referenced service. A port name or port number is required for a IngressServiceBackend.
<a name="ServiceBackendPort"></a>
*ServiceBackendPort is the service port being referenced.*
- **service.port.name** (string)
Name is the name of the port on the Service. This is a mutually exclusive setting with "Number".
- **service.port.number** (int32)
Number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name".
## IngressStatus {#IngressStatus}
IngressStatus describe the current state of the Ingress.
@ -196,37 +222,37 @@ IngressStatus describe the current state of the Ingress.
<a name="LoadBalancerIngress"></a>
*LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.*
- **loadBalancer.ingress.hostname** (string)
- **loadBalancer.ingress.hostname** (string)
Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
- **loadBalancer.ingress.ip** (string)
- **loadBalancer.ingress.ip** (string)
IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
- **loadBalancer.ingress.ports** ([]PortStatus)
- **loadBalancer.ingress.ports** ([]PortStatus)
*Atomic: will be replaced during a merge*
Ports is a list of records of service ports If used, every port defined in the service should have an entry in it
*Atomic: will be replaced during a merge*
Ports is a list of records of service ports If used, every port defined in the service should have an entry in it
<a name="PortStatus"></a>
**
<a name="PortStatus"></a>
**
- **loadBalancer.ingress.ports.port** (int32), required
- **loadBalancer.ingress.ports.port** (int32), required
Port is the port number of the service port of which status is recorded here
Port is the port number of the service port of which status is recorded here
- **loadBalancer.ingress.ports.protocol** (string), required
- **loadBalancer.ingress.ports.protocol** (string), required
Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"
Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"
- **loadBalancer.ingress.ports.error** (string)
- **loadBalancer.ingress.ports.error** (string)
Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use
CamelCase names
- cloud provider specific error values must have names that comply with the
format foo.example.com/CamelCase.
Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use
CamelCase names
- cloud provider specific error values must have names that comply with the
format foo.example.com/CamelCase.
@ -238,22 +264,20 @@ IngressList is a collection of Ingress.
<hr>
- **items** ([]<a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>), required
- **apiVersion**: networking.k8s.io/v1
Items is the list of Ingress.
- **apiVersion** (string)
- **kind**: IngressList
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** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="{{< ref "../services-resources/ingress-v1#Ingress" >}}">Ingress</a>), required
Items is the list of Ingress.
@ -297,7 +321,7 @@ GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}
#### Response
200 (<a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>): OK
200 (<a href="{{< ref "../services-resources/ingress-v1#Ingress" >}}">Ingress</a>): OK
401: Unauthorized
@ -330,7 +354,7 @@ GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status
#### Response
200 (<a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>): OK
200 (<a href="{{< ref "../services-resources/ingress-v1#Ingress" >}}">Ingress</a>): OK
401: Unauthorized
@ -403,7 +427,7 @@ GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses
#### Response
200 (<a href="{{< ref "../service-resources/ingress-v1#IngressList" >}}">IngressList</a>): OK
200 (<a href="{{< ref "../services-resources/ingress-v1#IngressList" >}}">IngressList</a>): OK
401: Unauthorized
@ -471,7 +495,7 @@ GET /apis/networking.k8s.io/v1/ingresses
#### Response
200 (<a href="{{< ref "../service-resources/ingress-v1#IngressList" >}}">IngressList</a>): OK
200 (<a href="{{< ref "../services-resources/ingress-v1#IngressList" >}}">IngressList</a>): OK
401: Unauthorized
@ -490,7 +514,7 @@ POST /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>, required
- **body**: <a href="{{< ref "../services-resources/ingress-v1#Ingress" >}}">Ingress</a>, required
@ -514,11 +538,11 @@ POST /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses
#### Response
200 (<a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>): OK
200 (<a href="{{< ref "../services-resources/ingress-v1#Ingress" >}}">Ingress</a>): OK
201 (<a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>): Created
201 (<a href="{{< ref "../services-resources/ingress-v1#Ingress" >}}">Ingress</a>): Created
202 (<a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>): Accepted
202 (<a href="{{< ref "../services-resources/ingress-v1#Ingress" >}}">Ingress</a>): Accepted
401: Unauthorized
@ -542,7 +566,7 @@ PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>, required
- **body**: <a href="{{< ref "../services-resources/ingress-v1#Ingress" >}}">Ingress</a>, required
@ -566,9 +590,9 @@ PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}
#### Response
200 (<a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>): OK
200 (<a href="{{< ref "../services-resources/ingress-v1#Ingress" >}}">Ingress</a>): OK
201 (<a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>): Created
201 (<a href="{{< ref "../services-resources/ingress-v1#Ingress" >}}">Ingress</a>): Created
401: Unauthorized
@ -592,7 +616,7 @@ PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>, required
- **body**: <a href="{{< ref "../services-resources/ingress-v1#Ingress" >}}">Ingress</a>, required
@ -616,9 +640,9 @@ PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status
#### Response
200 (<a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>): OK
200 (<a href="{{< ref "../services-resources/ingress-v1#Ingress" >}}">Ingress</a>): OK
201 (<a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>): Created
201 (<a href="{{< ref "../services-resources/ingress-v1#Ingress" >}}">Ingress</a>): Created
401: Unauthorized
@ -671,7 +695,7 @@ PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}
#### Response
200 (<a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>): OK
200 (<a href="{{< ref "../services-resources/ingress-v1#Ingress" >}}">Ingress</a>): OK
401: Unauthorized
@ -724,7 +748,7 @@ PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status
#### Response
200 (<a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>): OK
200 (<a href="{{< ref "../services-resources/ingress-v1#Ingress" >}}">Ingress</a>): OK
401: Unauthorized

92
content/en/docs/reference/kubernetes-api/service-resources/service-v1.md → content/en/docs/reference/kubernetes-api/services-resources/service-v1.md
View File

@ -30,11 +30,11 @@ Service is a named abstraction of software service (for example, mysql) consisti
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../service-resources/service-v1#ServiceSpec" >}}">ServiceSpec</a>)
- **spec** (<a href="{{< ref "../services-resources/service-v1#ServiceSpec" >}}">ServiceSpec</a>)
Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="{{< ref "../service-resources/service-v1#ServiceStatus" >}}">ServiceStatus</a>)
- **status** (<a href="{{< ref "../services-resources/service-v1#ServiceStatus" >}}">ServiceStatus</a>)
Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@ -134,22 +134,14 @@ ServiceSpec describes the attributes that a user creates on a service.
If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/
- **loadBalancerClass** (string)
loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.
- **externalName** (string)
externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName".
externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be
- **externalTrafficPolicy** (string)
externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
- **internalTrafficPolicy** (string)
InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster".
- **healthCheckNodePort** (int32)
healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type).
@ -172,13 +164,13 @@ ServiceSpec describes the attributes that a user creates on a service.
<a name="ClientIPConfig"></a>
*ClientIPConfig represents the configurations of Client IP based session affinity.*
- **sessionAffinityConfig.clientIP.timeoutSeconds** (int32)
- **sessionAffinityConfig.clientIP.timeoutSeconds** (int32)
timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && \<=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).
timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && \<=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).
- **topologyKeys** ([]string)
topologyKeys is a preference-order list of topology keys which implementations of services should use to preferentially sort endpoints when accessing this Service, it can not be used at the same time as externalTrafficPolicy=Local. Topology keys must be valid label keys and at most 16 keys may be specified. Endpoints are chosen based on the first topology key with available backends. If this field is specified and all entries have no backends that match the topology of the client, the service has no backends for that client and connections should fail. The special value "*" may be used to mean "any topology". This catch-all value, if used, only makes sense as the last value in the list. If this is not specified or empty, no topology constraints will be applied. This field is alpha-level and is only honored by servers that enable the ServiceTopology feature. This field is deprecated and will be removed in a future version.
topologyKeys is a preference-order list of topology keys which implementations of services should use to preferentially sort endpoints when accessing this Service, it can not be used at the same time as externalTrafficPolicy=Local. Topology keys must be valid label keys and at most 16 keys may be specified. Endpoints are chosen based on the first topology key with available backends. If this field is specified and all entries have no backends that match the topology of the client, the service has no backends for that client and connections should fail. The special value "*" may be used to mean "any topology". This catch-all value, if used, only makes sense as the last value in the list. If this is not specified or empty, no topology constraints will be applied. This field is alpha-level and is only honored by servers that enable the ServiceTopology feature.
- **allocateLoadBalancerNodePorts** (boolean)
@ -246,37 +238,37 @@ ServiceStatus represents the current status of a service.
<a name="LoadBalancerIngress"></a>
*LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.*
- **loadBalancer.ingress.hostname** (string)
- **loadBalancer.ingress.hostname** (string)
Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
- **loadBalancer.ingress.ip** (string)
- **loadBalancer.ingress.ip** (string)
IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
- **loadBalancer.ingress.ports** ([]PortStatus)
- **loadBalancer.ingress.ports** ([]PortStatus)
*Atomic: will be replaced during a merge*
Ports is a list of records of service ports If used, every port defined in the service should have an entry in it
*Atomic: will be replaced during a merge*
Ports is a list of records of service ports If used, every port defined in the service should have an entry in it
<a name="PortStatus"></a>
**
<a name="PortStatus"></a>
**
- **loadBalancer.ingress.ports.port** (int32), required
- **loadBalancer.ingress.ports.port** (int32), required
Port is the port number of the service port of which status is recorded here
Port is the port number of the service port of which status is recorded here
- **loadBalancer.ingress.ports.protocol** (string), required
- **loadBalancer.ingress.ports.protocol** (string), required
Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"
Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"
- **loadBalancer.ingress.ports.error** (string)
- **loadBalancer.ingress.ports.error** (string)
Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use
CamelCase names
- cloud provider specific error values must have names that comply with the
format foo.example.com/CamelCase.
Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use
CamelCase names
- cloud provider specific error values must have names that comply with the
format foo.example.com/CamelCase.
@ -298,7 +290,7 @@ ServiceList holds a list of services.
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="{{< ref "../service-resources/service-v1#Service" >}}">Service</a>), required
- **items** ([]<a href="{{< ref "../services-resources/service-v1#Service" >}}">Service</a>), required
List of services
@ -345,7 +337,7 @@ GET /api/v1/namespaces/{namespace}/services/{name}
#### Response
200 (<a href="{{< ref "../service-resources/service-v1#Service" >}}">Service</a>): OK
200 (<a href="{{< ref "../services-resources/service-v1#Service" >}}">Service</a>): OK
401: Unauthorized
@ -378,7 +370,7 @@ GET /api/v1/namespaces/{namespace}/services/{name}/status
#### Response
200 (<a href="{{< ref "../service-resources/service-v1#Service" >}}">Service</a>): OK
200 (<a href="{{< ref "../services-resources/service-v1#Service" >}}">Service</a>): OK
401: Unauthorized
@ -451,7 +443,7 @@ GET /api/v1/namespaces/{namespace}/services
#### Response
200 (<a href="{{< ref "../service-resources/service-v1#ServiceList" >}}">ServiceList</a>): OK
200 (<a href="{{< ref "../services-resources/service-v1#ServiceList" >}}">ServiceList</a>): OK
401: Unauthorized
@ -519,7 +511,7 @@ GET /api/v1/services
#### Response
200 (<a href="{{< ref "../service-resources/service-v1#ServiceList" >}}">ServiceList</a>): OK
200 (<a href="{{< ref "../services-resources/service-v1#ServiceList" >}}">ServiceList</a>): OK
401: Unauthorized
@ -538,7 +530,7 @@ POST /api/v1/namespaces/{namespace}/services
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../service-resources/service-v1#Service" >}}">Service</a>, required
- **body**: <a href="{{< ref "../services-resources/service-v1#Service" >}}">Service</a>, required
@ -562,11 +554,11 @@ POST /api/v1/namespaces/{namespace}/services
#### Response
200 (<a href="{{< ref "../service-resources/service-v1#Service" >}}">Service</a>): OK
200 (<a href="{{< ref "../services-resources/service-v1#Service" >}}">Service</a>): OK
201 (<a href="{{< ref "../service-resources/service-v1#Service" >}}">Service</a>): Created
201 (<a href="{{< ref "../services-resources/service-v1#Service" >}}">Service</a>): Created
202 (<a href="{{< ref "../service-resources/service-v1#Service" >}}">Service</a>): Accepted
202 (<a href="{{< ref "../services-resources/service-v1#Service" >}}">Service</a>): Accepted
401: Unauthorized
@ -590,7 +582,7 @@ PUT /api/v1/namespaces/{namespace}/services/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../service-resources/service-v1#Service" >}}">Service</a>, required
- **body**: <a href="{{< ref "../services-resources/service-v1#Service" >}}">Service</a>, required
@ -614,9 +606,9 @@ PUT /api/v1/namespaces/{namespace}/services/{name}
#### Response
200 (<a href="{{< ref "../service-resources/service-v1#Service" >}}">Service</a>): OK
200 (<a href="{{< ref "../services-resources/service-v1#Service" >}}">Service</a>): OK
201 (<a href="{{< ref "../service-resources/service-v1#Service" >}}">Service</a>): Created
201 (<a href="{{< ref "../services-resources/service-v1#Service" >}}">Service</a>): Created
401: Unauthorized
@ -640,7 +632,7 @@ PUT /api/v1/namespaces/{namespace}/services/{name}/status
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../service-resources/service-v1#Service" >}}">Service</a>, required
- **body**: <a href="{{< ref "../services-resources/service-v1#Service" >}}">Service</a>, required
@ -664,9 +656,9 @@ PUT /api/v1/namespaces/{namespace}/services/{name}/status
#### Response
200 (<a href="{{< ref "../service-resources/service-v1#Service" >}}">Service</a>): OK
200 (<a href="{{< ref "../services-resources/service-v1#Service" >}}">Service</a>): OK
201 (<a href="{{< ref "../service-resources/service-v1#Service" >}}">Service</a>): Created
201 (<a href="{{< ref "../services-resources/service-v1#Service" >}}">Service</a>): Created
401: Unauthorized
@ -719,7 +711,7 @@ PATCH /api/v1/namespaces/{namespace}/services/{name}
#### Response
200 (<a href="{{< ref "../service-resources/service-v1#Service" >}}">Service</a>): OK
200 (<a href="{{< ref "../services-resources/service-v1#Service" >}}">Service</a>): OK
401: Unauthorized
@ -772,7 +764,7 @@ PATCH /api/v1/namespaces/{namespace}/services/{name}/status
#### Response
200 (<a href="{{< ref "../service-resources/service-v1#Service" >}}">Service</a>): OK
200 (<a href="{{< ref "../services-resources/service-v1#Service" >}}">Service</a>): OK
401: Unauthorized

4
content/en/docs/reference/kubernetes-api/workload-resources/_index.md
View File

@ -1,4 +0,0 @@
---
title: "Workload Resources"
weight: 1
---

2631
content/en/docs/reference/kubernetes-api/workload-resources/pod-v1.md
View File

File diff suppressed because it is too large Load Diff

4
content/en/docs/reference/kubernetes-api/workloads-resources/_index.md Normal file
View File

@ -0,0 +1,4 @@
---
title: "Workloads Resources"
weight: 1
---

774
content/en/docs/reference/kubernetes-api/workloads-resources/container.md Normal file
View File

@ -0,0 +1,774 @@
---
api_metadata:
apiVersion: ""
import: "k8s.io/api/core/v1"
kind: "Container"
content_type: "api_reference"
description: "A single application container that you want to run within a pod."
title: "Container"
weight: 2
---
`import "k8s.io/api/core/v1"`
## Container {#Container}
A single application container that you want to run within a pod.
<hr>
- **name** (string), required
Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
### Image
- **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
### Entrypoint
- **command** ([]string)
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
- **args** ([]string)
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
- **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.
### Ports
- **ports** ([]ContainerPort)
*Patch strategy: merge on key `containerPort`*
*Map: unique values on keys `containerPort, protocol` will be kept during a merge*
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.
<a name="ContainerPort"></a>
*ContainerPort represents a network port in a single container.*
- **ports.containerPort** (int32), required
Number of port to expose on the pod's IP address. This must be a valid port number, 0 \< x \< 65536.
- **ports.hostIP** (string)
What host IP to bind the external port to.
- **ports.hostPort** (int32)
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.
- **ports.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.
- **ports.protocol** (string)
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
### Environment variables
- **env** ([]EnvVar)
*Patch strategy: merge on key `name`*
List of environment variables to set in the container. Cannot be updated.
<a name="EnvVar"></a>
*EnvVar represents an environment variable present in a Container.*
- **env.name** (string), required
Name of the environment variable. Must be a C_IDENTIFIER.
- **env.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 "".
- **env.valueFrom** (EnvVarSource)
Source for the environment variable's value. Cannot be used if value is not empty.
<a name="EnvVarSource"></a>
*EnvVarSource represents a source for the value of an EnvVar.*
- **env.valueFrom.configMapKeyRef** (ConfigMapKeySelector)
Selects a key of a ConfigMap.
<a name="ConfigMapKeySelector"></a>
*Selects a key from a ConfigMap.*
- **env.valueFrom.configMapKeyRef.key** (string), required
The key to select.
- **env.valueFrom.configMapKeyRef.name** (string)
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **env.valueFrom.configMapKeyRef.optional** (boolean)
Specify whether the ConfigMap or its key must be defined
- **env.valueFrom.fieldRef** (<a href="{{< ref "../common-definitions/object-field-selector#ObjectFieldSelector" >}}">ObjectFieldSelector</a>)
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.
- **env.valueFrom.resourceFieldRef** (<a href="{{< ref "../common-definitions/resource-field-selector#ResourceFieldSelector" >}}">ResourceFieldSelector</a>)
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.
- **env.valueFrom.secretKeyRef** (SecretKeySelector)
Selects a key of a secret in the pod's namespace
<a name="SecretKeySelector"></a>
*SecretKeySelector selects a key of a Secret.*
- **env.valueFrom.secretKeyRef.key** (string), required
The key of the secret to select from. Must be a valid secret key.
- **env.valueFrom.secretKeyRef.name** (string)
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **env.valueFrom.secretKeyRef.optional** (boolean)
Specify whether the Secret or its key must be defined
- **envFrom** ([]EnvFromSource)
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.
<a name="EnvFromSource"></a>
*EnvFromSource represents the source of a set of ConfigMaps*
- **envFrom.configMapRef** (ConfigMapEnvSource)
The ConfigMap to select from
<a name="ConfigMapEnvSource"></a>
*ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.*
- **envFrom.configMapRef.name** (string)
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **envFrom.configMapRef.optional** (boolean)
Specify whether the ConfigMap must be defined
- **envFrom.prefix** (string)
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
- **envFrom.secretRef** (SecretEnvSource)
The Secret to select from
<a name="SecretEnvSource"></a>
*SecretEnvSource selects a Secret to populate the environment variables with.
The contents of the target Secret's Data field will represent the key-value pairs as environment variables.*
- **envFrom.secretRef.name** (string)
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **envFrom.secretRef.optional** (boolean)
Specify whether the Secret must be defined
### Volumes
- **volumeMounts** ([]VolumeMount)
*Patch strategy: merge on key `mountPath`*
Pod volumes to mount into the container's filesystem. Cannot be updated.
<a name="VolumeMount"></a>
*VolumeMount describes a mounting of a Volume within a container.*
- **volumeMounts.mountPath** (string), required
Path within the container at which the volume should be mounted. Must not contain ':'.
- **volumeMounts.name** (string), required
This must match the Name of a Volume.
- **volumeMounts.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.
- **volumeMounts.readOnly** (boolean)
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
- **volumeMounts.subPath** (string)
Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
- **volumeMounts.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.
- **volumeDevices** ([]VolumeDevice)
*Patch strategy: merge on key `devicePath`*
volumeDevices is the list of block devices to be used by the container.
<a name="VolumeDevice"></a>
*volumeDevice describes a mapping of a raw block device within a container.*
- **volumeDevices.devicePath** (string), required
devicePath is the path inside of the container that the device will be mapped to.
- **volumeDevices.name** (string), required
name must match the name of a persistentVolumeClaim in the pod
### Resources
- **resources** (ResourceRequirements)
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
<a name="ResourceRequirements"></a>
*ResourceRequirements describes the compute resource requirements.*
- **resources.limits** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
- **resources.requests** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
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/
### Lifecycle
- **lifecycle** (Lifecycle)
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
<a name="Lifecycle"></a>
*Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.*
- **lifecycle.postStart** (Handler)
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
<a name="Handler"></a>
*Handler defines a specific action that should be taken*
- **lifecycle.postStart.exec** (<a href="{{< ref "../common-definitions/exec-action#ExecAction" >}}">ExecAction</a>)
One and only one of the following should be specified. Exec specifies the action to take.
- **lifecycle.postStart.httpGet** (<a href="{{< ref "../common-definitions/http-get-action#HTTPGetAction" >}}">HTTPGetAction</a>)
HTTPGet specifies the http request to perform.
- **lifecycle.postStart.tcpSocket** (<a href="{{< ref "../common-definitions/tcp-socket-action#TCPSocketAction" >}}">TCPSocketAction</a>)
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
- **lifecycle.preStop** (Handler)
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
<a name="Handler"></a>
*Handler defines a specific action that should be taken*
- **lifecycle.preStop.exec** (<a href="{{< ref "../common-definitions/exec-action#ExecAction" >}}">ExecAction</a>)
One and only one of the following should be specified. Exec specifies the action to take.
- **lifecycle.preStop.httpGet** (<a href="{{< ref "../common-definitions/http-get-action#HTTPGetAction" >}}">HTTPGetAction</a>)
HTTPGet specifies the http request to perform.
- **lifecycle.preStop.tcpSocket** (<a href="{{< ref "../common-definitions/tcp-socket-action#TCPSocketAction" >}}">TCPSocketAction</a>)
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
- **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.
- **livenessProbe** (Probe)
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
<a name="Probe"></a>
*Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.*
- **livenessProbe.exec** (<a href="{{< ref "../common-definitions/exec-action#ExecAction" >}}">ExecAction</a>)
One and only one of the following should be specified. Exec specifies the action to take.
- **livenessProbe.httpGet** (<a href="{{< ref "../common-definitions/http-get-action#HTTPGetAction" >}}">HTTPGetAction</a>)
HTTPGet specifies the http request to perform.
- **livenessProbe.tcpSocket** (<a href="{{< ref "../common-definitions/tcp-socket-action#TCPSocketAction" >}}">TCPSocketAction</a>)
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
- **livenessProbe.initialDelaySeconds** (int32)
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
- **livenessProbe.periodSeconds** (int32)
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
- **livenessProbe.timeoutSeconds** (int32)
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
- **livenessProbe.failureThreshold** (int32)
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- **livenessProbe.successThreshold** (int32)
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.
- **readinessProbe** (Probe)
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
<a name="Probe"></a>
*Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.*
- **readinessProbe.exec** (<a href="{{< ref "../common-definitions/exec-action#ExecAction" >}}">ExecAction</a>)
One and only one of the following should be specified. Exec specifies the action to take.
- **readinessProbe.httpGet** (<a href="{{< ref "../common-definitions/http-get-action#HTTPGetAction" >}}">HTTPGetAction</a>)
HTTPGet specifies the http request to perform.
- **readinessProbe.tcpSocket** (<a href="{{< ref "../common-definitions/tcp-socket-action#TCPSocketAction" >}}">TCPSocketAction</a>)
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
- **readinessProbe.initialDelaySeconds** (int32)
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
- **readinessProbe.periodSeconds** (int32)
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
- **readinessProbe.timeoutSeconds** (int32)
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
- **readinessProbe.failureThreshold** (int32)
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- **readinessProbe.successThreshold** (int32)
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.
### Security Context
- **securityContext** (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/
<a name="SecurityContext"></a>
*SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.*
- **securityContext.runAsUser** (int64)
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.
- **securityContext.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.
- **securityContext.runAsGroup** (int64)
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.
- **securityContext.readOnlyRootFilesystem** (boolean)
Whether this container has a read-only root filesystem. Default is false.
- **securityContext.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.
- **securityContext.privileged** (boolean)
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
- **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
- **securityContext.capabilities** (Capabilities)
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
<a name="Capabilities"></a>
*Adds and removes POSIX capabilities from running containers.*
- **securityContext.capabilities.add** ([]string)
Added capabilities
- **securityContext.capabilities.drop** ([]string)
Removed capabilities
- **securityContext.seccompProfile** (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.
<a name="SeccompProfile"></a>
*SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.*
- **securityContext.seccompProfile.type** (string), required
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.
- **securityContext.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".
- **securityContext.seLinuxOptions** (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.
<a name="SELinuxOptions"></a>
*SELinuxOptions are the labels to be applied to the container*
- **securityContext.seLinuxOptions.level** (string)
Level is SELinux level label that applies to the container.
- **securityContext.seLinuxOptions.role** (string)
Role is a SELinux role label that applies to the container.
- **securityContext.seLinuxOptions.type** (string)
Type is a SELinux type label that applies to the container.
- **securityContext.seLinuxOptions.user** (string)
User is a SELinux user label that applies to the container.
- **securityContext.windowsOptions** (WindowsSecurityContextOptions)
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.
<a name="WindowsSecurityContextOptions"></a>
*WindowsSecurityContextOptions contain Windows-specific options and credentials.*
- **securityContext.windowsOptions.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.
- **securityContext.windowsOptions.gmsaCredentialSpecName** (string)
GMSACredentialSpecName is the name of the GMSA credential spec to use.
- **securityContext.windowsOptions.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.
### Debugging
- **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
- **tty** (boolean)
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
### Beta level
- **startupProbe** (Probe)
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
<a name="Probe"></a>
*Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.*
- **startupProbe.exec** (<a href="{{< ref "../common-definitions/exec-action#ExecAction" >}}">ExecAction</a>)
One and only one of the following should be specified. Exec specifies the action to take.
- **startupProbe.httpGet** (<a href="{{< ref "../common-definitions/http-get-action#HTTPGetAction" >}}">HTTPGetAction</a>)
HTTPGet specifies the http request to perform.
- **startupProbe.tcpSocket** (<a href="{{< ref "../common-definitions/tcp-socket-action#TCPSocketAction" >}}">TCPSocketAction</a>)
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
- **startupProbe.initialDelaySeconds** (int32)
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
- **startupProbe.periodSeconds** (int32)
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
- **startupProbe.timeoutSeconds** (int32)
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
- **startupProbe.failureThreshold** (int32)
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- **startupProbe.successThreshold** (int32)
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.
## ContainerStatus {#ContainerStatus}
ContainerStatus contains details for the current status of this container.
<hr>
- **name** (string), required
This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
- **image** (string), required
The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images
- **imageID** (string), required
ImageID of the container's image.
- **containerID** (string)
Container's ID in the format 'docker://\<container_id>'.
- **state** (ContainerState)
Details about the container's current condition.
<a name="ContainerState"></a>
*ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.*
- **state.running** (ContainerStateRunning)
Details about a running container
<a name="ContainerStateRunning"></a>
*ContainerStateRunning is a running state of a container.*
- **state.running.startedAt** (Time)
Time at which the container was last (re-)started
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **state.terminated** (ContainerStateTerminated)
Details about a terminated container
<a name="ContainerStateTerminated"></a>
*ContainerStateTerminated is a terminated state of a container.*
- **state.terminated.containerID** (string)
Container's ID in the format 'docker://\<container_id>'
- **state.terminated.exitCode** (int32), required
Exit status from the last termination of the container
- **state.terminated.startedAt** (Time)
Time at which previous execution of the container started
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **state.terminated.finishedAt** (Time)
Time at which the container last terminated
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **state.terminated.message** (string)
Message regarding the last termination of the container
- **state.terminated.reason** (string)
(brief) reason from the last termination of the container
- **state.terminated.signal** (int32)
Signal from the last termination of the container
- **state.waiting** (ContainerStateWaiting)
Details about a waiting container
<a name="ContainerStateWaiting"></a>
*ContainerStateWaiting is a waiting state of a container.*
- **state.waiting.message** (string)
Message regarding why the container is not yet running.
- **state.waiting.reason** (string)
(brief) reason the container is not yet running.
- **lastState** (ContainerState)
Details about the container's last termination condition.
<a name="ContainerState"></a>
*ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.*
- **lastState.running** (ContainerStateRunning)
Details about a running container
<a name="ContainerStateRunning"></a>
*ContainerStateRunning is a running state of a container.*
- **lastState.running.startedAt** (Time)
Time at which the container was last (re-)started
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **lastState.terminated** (ContainerStateTerminated)
Details about a terminated container
<a name="ContainerStateTerminated"></a>
*ContainerStateTerminated is a terminated state of a container.*
- **lastState.terminated.containerID** (string)
Container's ID in the format 'docker://\<container_id>'
- **lastState.terminated.exitCode** (int32), required
Exit status from the last termination of the container
- **lastState.terminated.startedAt** (Time)
Time at which previous execution of the container started
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **lastState.terminated.finishedAt** (Time)
Time at which the container last terminated
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **lastState.terminated.message** (string)
Message regarding the last termination of the container
- **lastState.terminated.reason** (string)
(brief) reason from the last termination of the container
- **lastState.terminated.signal** (int32)
Signal from the last termination of the container
- **lastState.waiting** (ContainerStateWaiting)
Details about a waiting container
<a name="ContainerStateWaiting"></a>
*ContainerStateWaiting is a waiting state of a container.*
- **lastState.waiting.message** (string)
Message regarding why the container is not yet running.
- **lastState.waiting.reason** (string)
(brief) reason the container is not yet running.
- **ready** (boolean), required
Specifies whether the container has passed its readiness probe.
- **restartCount** (int32), required
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.

26
content/en/docs/reference/kubernetes-api/workload-resources/controller-revision-v1.md → content/en/docs/reference/kubernetes-api/workloads-resources/controller-revision-v1.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "ControllerRevision implements an immutable snapshot of state data."
title: "ControllerRevision"
weight: 8
weight: 9
---
`apiVersion: apps/v1`
@ -88,7 +88,7 @@ ControllerRevisionList is a resource containing a list of ControllerRevision obj
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="{{< ref "../workload-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>), required
- **items** ([]<a href="{{< ref "../workloads-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>), required
Items is the list of ControllerRevisions
@ -135,7 +135,7 @@ GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>): OK
200 (<a href="{{< ref "../workloads-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>): OK
401: Unauthorized
@ -208,7 +208,7 @@ GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions
#### Response
200 (<a href="{{< ref "../workload-resources/controller-revision-v1#ControllerRevisionList" >}}">ControllerRevisionList</a>): OK
200 (<a href="{{< ref "../workloads-resources/controller-revision-v1#ControllerRevisionList" >}}">ControllerRevisionList</a>): OK
401: Unauthorized
@ -276,7 +276,7 @@ GET /apis/apps/v1/controllerrevisions
#### Response
200 (<a href="{{< ref "../workload-resources/controller-revision-v1#ControllerRevisionList" >}}">ControllerRevisionList</a>): OK
200 (<a href="{{< ref "../workloads-resources/controller-revision-v1#ControllerRevisionList" >}}">ControllerRevisionList</a>): OK
401: Unauthorized
@ -295,7 +295,7 @@ POST /apis/apps/v1/namespaces/{namespace}/controllerrevisions
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>, required
- **body**: <a href="{{< ref "../workloads-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>, required
@ -319,11 +319,11 @@ POST /apis/apps/v1/namespaces/{namespace}/controllerrevisions
#### Response
200 (<a href="{{< ref "../workload-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>): OK
200 (<a href="{{< ref "../workloads-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>): OK
201 (<a href="{{< ref "../workload-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>): Created
201 (<a href="{{< ref "../workloads-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>): Created
202 (<a href="{{< ref "../workload-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>): Accepted
202 (<a href="{{< ref "../workloads-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>): Accepted
401: Unauthorized
@ -347,7 +347,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>, required
- **body**: <a href="{{< ref "../workloads-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>, required
@ -371,9 +371,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>): OK
200 (<a href="{{< ref "../workloads-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>): OK
201 (<a href="{{< ref "../workload-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>): Created
201 (<a href="{{< ref "../workloads-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>): Created
401: Unauthorized
@ -426,7 +426,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>): OK
200 (<a href="{{< ref "../workloads-resources/controller-revision-v1#ControllerRevision" >}}">ControllerRevision</a>): OK
401: Unauthorized

91
content/en/docs/reference/kubernetes-api/workload-resources/cron-job-v1.md → content/en/docs/reference/kubernetes-api/workloads-resources/cron-job-v1beta1.md
View File

@ -1,17 +1,17 @@
---
api_metadata:
apiVersion: "batch/v1"
import: "k8s.io/api/batch/v1"
apiVersion: "batch/v1beta1"
import: "k8s.io/api/batch/v1beta1"
kind: "CronJob"
content_type: "api_reference"
description: "CronJob represents the configuration of a single cron job."
title: "CronJob"
weight: 11
title: "CronJob v1beta1"
weight: 12
---
`apiVersion: batch/v1`
`apiVersion: batch/v1beta1`
`import "k8s.io/api/batch/v1"`
`import "k8s.io/api/batch/v1beta1"`
## CronJob {#CronJob}
@ -20,7 +20,7 @@ CronJob represents the configuration of a single cron job.
<hr>
- **apiVersion**: batch/v1
- **apiVersion**: batch/v1beta1
- **kind**: CronJob
@ -30,11 +30,11 @@ CronJob represents the configuration of a single cron job.
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../workload-resources/cron-job-v1#CronJobSpec" >}}">CronJobSpec</a>)
- **spec** (<a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJobSpec" >}}">CronJobSpec</a>)
Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="{{< ref "../workload-resources/cron-job-v1#CronJobStatus" >}}">CronJobStatus</a>)
- **status** (<a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJobStatus" >}}">CronJobStatus</a>)
Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@ -59,7 +59,7 @@ CronJobSpec describes how the job execution will look like and when it will actu
Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **jobTemplate.spec** (<a href="{{< ref "../workload-resources/job-v1#JobSpec" >}}">JobSpec</a>)
- **jobTemplate.spec** (<a href="{{< ref "../workloads-resources/job-v1#JobSpec" >}}">JobSpec</a>)
Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@ -81,11 +81,11 @@ CronJobSpec describes how the job execution will look like and when it will actu
- **successfulJobsHistoryLimit** (int32)
The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.
The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.
- **failedJobsHistoryLimit** (int32)
The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1.
The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
@ -99,8 +99,6 @@ CronJobStatus represents the current state of a cron job.
- **active** ([]<a href="{{< ref "../common-definitions/object-reference#ObjectReference" >}}">ObjectReference</a>)
*Atomic: will be replaced during a merge*
A list of pointers to currently running jobs.
- **lastScheduleTime** (Time)
@ -110,13 +108,6 @@ CronJobStatus represents the current state of a cron job.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
- **lastSuccessfulTime** (Time)
Information when was the last time the job successfully completed.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
@ -127,7 +118,7 @@ CronJobList is a collection of cron jobs.
<hr>
- **apiVersion**: batch/v1
- **apiVersion**: batch/v1beta1
- **kind**: CronJobList
@ -137,7 +128,7 @@ CronJobList is a collection of cron jobs.
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="{{< ref "../workload-resources/cron-job-v1#CronJob" >}}">CronJob</a>), required
- **items** ([]<a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJob" >}}">CronJob</a>), required
items is the list of CronJobs.
@ -160,7 +151,7 @@ CronJobList is a collection of cron jobs.
#### HTTP Request
GET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
#### Parameters
@ -184,7 +175,7 @@ GET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/cron-job-v1#CronJob" >}}">CronJob</a>): OK
200 (<a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJob" >}}">CronJob</a>): OK
401: Unauthorized
@ -193,7 +184,7 @@ GET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
#### HTTP Request
GET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status
#### Parameters
@ -217,7 +208,7 @@ GET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/cron-job-v1#CronJob" >}}">CronJob</a>): OK
200 (<a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJob" >}}">CronJob</a>): OK
401: Unauthorized
@ -226,7 +217,7 @@ GET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
#### HTTP Request
GET /apis/batch/v1/namespaces/{namespace}/cronjobs
GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
#### Parameters
@ -290,7 +281,7 @@ GET /apis/batch/v1/namespaces/{namespace}/cronjobs
#### Response
200 (<a href="{{< ref "../workload-resources/cron-job-v1#CronJobList" >}}">CronJobList</a>): OK
200 (<a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJobList" >}}">CronJobList</a>): OK
401: Unauthorized
@ -299,7 +290,7 @@ GET /apis/batch/v1/namespaces/{namespace}/cronjobs
#### HTTP Request
GET /apis/batch/v1/cronjobs
GET /apis/batch/v1beta1/cronjobs
#### Parameters
@ -358,7 +349,7 @@ GET /apis/batch/v1/cronjobs
#### Response
200 (<a href="{{< ref "../workload-resources/cron-job-v1#CronJobList" >}}">CronJobList</a>): OK
200 (<a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJobList" >}}">CronJobList</a>): OK
401: Unauthorized
@ -367,7 +358,7 @@ GET /apis/batch/v1/cronjobs
#### HTTP Request
POST /apis/batch/v1/namespaces/{namespace}/cronjobs
POST /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
#### Parameters
@ -377,7 +368,7 @@ POST /apis/batch/v1/namespaces/{namespace}/cronjobs
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/cron-job-v1#CronJob" >}}">CronJob</a>, required
- **body**: <a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJob" >}}">CronJob</a>, required
@ -401,11 +392,11 @@ POST /apis/batch/v1/namespaces/{namespace}/cronjobs
#### Response
200 (<a href="{{< ref "../workload-resources/cron-job-v1#CronJob" >}}">CronJob</a>): OK
200 (<a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJob" >}}">CronJob</a>): OK
201 (<a href="{{< ref "../workload-resources/cron-job-v1#CronJob" >}}">CronJob</a>): Created
201 (<a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJob" >}}">CronJob</a>): Created
202 (<a href="{{< ref "../workload-resources/cron-job-v1#CronJob" >}}">CronJob</a>): Accepted
202 (<a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJob" >}}">CronJob</a>): Accepted
401: Unauthorized
@ -414,7 +405,7 @@ POST /apis/batch/v1/namespaces/{namespace}/cronjobs
#### HTTP Request
PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
#### Parameters
@ -429,7 +420,7 @@ PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/cron-job-v1#CronJob" >}}">CronJob</a>, required
- **body**: <a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJob" >}}">CronJob</a>, required
@ -453,9 +444,9 @@ PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/cron-job-v1#CronJob" >}}">CronJob</a>): OK
200 (<a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJob" >}}">CronJob</a>): OK
201 (<a href="{{< ref "../workload-resources/cron-job-v1#CronJob" >}}">CronJob</a>): Created
201 (<a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJob" >}}">CronJob</a>): Created
401: Unauthorized
@ -464,7 +455,7 @@ PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
#### HTTP Request
PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status
#### Parameters
@ -479,7 +470,7 @@ PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/cron-job-v1#CronJob" >}}">CronJob</a>, required
- **body**: <a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJob" >}}">CronJob</a>, required
@ -503,9 +494,9 @@ PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/cron-job-v1#CronJob" >}}">CronJob</a>): OK
200 (<a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJob" >}}">CronJob</a>): OK
201 (<a href="{{< ref "../workload-resources/cron-job-v1#CronJob" >}}">CronJob</a>): Created
201 (<a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJob" >}}">CronJob</a>): Created
401: Unauthorized
@ -514,7 +505,7 @@ PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
#### HTTP Request
PATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
#### Parameters
@ -558,7 +549,7 @@ PATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/cron-job-v1#CronJob" >}}">CronJob</a>): OK
200 (<a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJob" >}}">CronJob</a>): OK
401: Unauthorized
@ -567,7 +558,7 @@ PATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
#### HTTP Request
PATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status
#### Parameters
@ -611,7 +602,7 @@ PATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/cron-job-v1#CronJob" >}}">CronJob</a>): OK
200 (<a href="{{< ref "../workloads-resources/cron-job-v1beta1#CronJob" >}}">CronJob</a>): OK
401: Unauthorized
@ -620,7 +611,7 @@ PATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
#### HTTP Request
DELETE /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
#### Parameters
@ -675,7 +666,7 @@ DELETE /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
#### HTTP Request
DELETE /apis/batch/v1/namespaces/{namespace}/cronjobs
DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
#### Parameters

746
content/en/docs/reference/kubernetes-api/workloads-resources/cron-job-v2alpha1.md Normal file
View File

@ -0,0 +1,746 @@
---
api_metadata:
apiVersion: "batch/v2alpha1"
import: "k8s.io/api/batch/v2alpha1"
kind: "CronJob"
content_type: "api_reference"
description: "CronJob represents the configuration of a single cron job."
title: "CronJob v2alpha1"
weight: 13
---
`apiVersion: batch/v2alpha1`
`import "k8s.io/api/batch/v2alpha1"`
## CronJob {#CronJob}
CronJob represents the configuration of a single cron job.
<hr>
- **apiVersion**: batch/v2alpha1
- **kind**: CronJob
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJobSpec" >}}">CronJobSpec</a>)
Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJobStatus" >}}">CronJobStatus</a>)
Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## CronJobSpec {#CronJobSpec}
CronJobSpec describes how the job execution will look like and when it will actually run.
<hr>
- **jobTemplate** (JobTemplateSpec), required
Specifies the job that will be created when executing a CronJob.
<a name="JobTemplateSpec"></a>
*JobTemplateSpec describes the data a Job should have when created from a template*
- **jobTemplate.metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **jobTemplate.spec** (<a href="{{< ref "../workloads-resources/job-v1#JobSpec" >}}">JobSpec</a>)
Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **schedule** (string), required
The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
- **concurrencyPolicy** (string)
Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one
- **failedJobsHistoryLimit** (int32)
The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.
- **startingDeadlineSeconds** (int64)
Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
- **successfulJobsHistoryLimit** (int32)
The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.
- **suspend** (boolean)
This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
## CronJobStatus {#CronJobStatus}
CronJobStatus represents the current state of a cron job.
<hr>
- **active** ([]<a href="{{< ref "../common-definitions/object-reference#ObjectReference" >}}">ObjectReference</a>)
A list of pointers to currently running jobs.
- **lastScheduleTime** (Time)
Information when was the last time the job was successfully scheduled.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
## CronJobList {#CronJobList}
CronJobList is a collection of cron jobs.
<hr>
- **apiVersion**: batch/v2alpha1
- **kind**: CronJobList
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJob" >}}">CronJob</a>), required
items is the list of CronJobs.
## Operations {#Operations}
<hr>
### `get` read the specified CronJob
#### HTTP Request
GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CronJob
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJob" >}}">CronJob</a>): OK
401: Unauthorized
### `get` read status of the specified CronJob
#### HTTP Request
GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the CronJob
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJob" >}}">CronJob</a>): OK
401: Unauthorized
### `list` list or watch objects of kind CronJob
#### HTTP Request
GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs
#### Parameters
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **allowWatchBookmarks** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue</a>
- **fieldSelector** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector</a>
- **limit** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
- **resourceVersion** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch</a>
#### Response
200 (<a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJobList" >}}">CronJobList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind CronJob
#### HTTP Request
GET /apis/batch/v2alpha1/cronjobs
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks</a>
- **continue** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue</a>
- **fieldSelector** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector</a>
- **labelSelector** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector</a>
- **limit** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
- **resourceVersion** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
- **watch** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch</a>
#### Response
200 (<a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJobList" >}}">CronJobList</a>): OK
401: Unauthorized
### `create` create a CronJob
#### HTTP Request
POST /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs
#### Parameters
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJob" >}}">CronJob</a>, required
- **dryRun** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
- **fieldManager** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJob" >}}">CronJob</a>): OK
201 (<a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJob" >}}">CronJob</a>): Created
202 (<a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJob" >}}">CronJob</a>): Accepted
401: Unauthorized
### `update` replace the specified CronJob
#### HTTP Request
PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CronJob
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJob" >}}">CronJob</a>, required
- **dryRun** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
- **fieldManager** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJob" >}}">CronJob</a>): OK
201 (<a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJob" >}}">CronJob</a>): Created
401: Unauthorized
### `update` replace status of the specified CronJob
#### HTTP Request
PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the CronJob
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJob" >}}">CronJob</a>, required
- **dryRun** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
- **fieldManager** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJob" >}}">CronJob</a>): OK
201 (<a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJob" >}}">CronJob</a>): Created
401: Unauthorized
### `patch` partially update the specified CronJob
#### HTTP Request
PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CronJob
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>, required
- **dryRun** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
- **fieldManager** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
- **force** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJob" >}}">CronJob</a>): OK
401: Unauthorized
### `patch` partially update status of the specified CronJob
#### HTTP Request
PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the CronJob
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>, required
- **dryRun** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
- **fieldManager** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
- **force** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../workloads-resources/cron-job-v2alpha1#CronJob" >}}">CronJob</a>): OK
401: Unauthorized
### `delete` delete a CronJob
#### HTTP Request
DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
#### Parameters
- **name** (*in path*): string, required
name of the CronJob
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a>
- **dryRun** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy</a>
#### Response
200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a>): OK
202 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of CronJob
#### HTTP Request
DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs
#### Parameters
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a>
- **continue** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue</a>
- **dryRun** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
- **fieldSelector** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector</a>
- **gracePeriodSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds</a>
- **labelSelector** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector</a>
- **limit** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
- **propagationPolicy** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy</a>
- **resourceVersion** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion</a>
- **resourceVersionMatch** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
#### Response
200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a>): OK
401: Unauthorized

57
content/en/docs/reference/kubernetes-api/workload-resources/daemon-set-v1.md → content/en/docs/reference/kubernetes-api/workloads-resources/daemon-set-v1.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "DaemonSet represents the configuration of a daemon set."
title: "DaemonSet"
weight: 9
weight: 10
---
`apiVersion: apps/v1`
@ -30,11 +30,11 @@ DaemonSet represents the configuration of a daemon set.
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSetSpec" >}}">DaemonSetSpec</a>)
- **spec** (<a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSetSpec" >}}">DaemonSetSpec</a>)
The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSetStatus" >}}">DaemonSetStatus</a>)
- **status** (<a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSetStatus" >}}">DaemonSetStatus</a>)
The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@ -52,7 +52,7 @@ DaemonSetSpec is the specification of a daemon set.
A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
- **template** (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec</a>), required
- **template** (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec</a>), required
An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
@ -78,19 +78,12 @@ DaemonSetSpec is the specification of a daemon set.
<a name="RollingUpdateDaemonSet"></a>
*Spec to control the desired behavior of daemon set rolling update.*
- **updateStrategy.rollingUpdate.maxSurge** (IntOrString)
- **updateStrategy.rollingUpdate.maxUnavailable** (IntOrString)
The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. 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 to a minimum of 1. Default value is 0. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediatedly created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption. This is an alpha field and requires enabling DaemonSetUpdateSurge feature gate.
The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **updateStrategy.rollingUpdate.maxUnavailable** (IntOrString)
The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding down to a minimum of one. This cannot be 0 if MaxSurge is 0 Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **revisionHistoryLimit** (int32)
@ -194,7 +187,7 @@ DaemonSetList is a collection of daemon sets.
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>), required
- **items** ([]<a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>), required
A list of daemon sets.
@ -241,7 +234,7 @@ GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): OK
401: Unauthorized
@ -274,7 +267,7 @@ GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): OK
401: Unauthorized
@ -347,7 +340,7 @@ GET /apis/apps/v1/namespaces/{namespace}/daemonsets
#### Response
200 (<a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSetList" >}}">DaemonSetList</a>): OK
200 (<a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSetList" >}}">DaemonSetList</a>): OK
401: Unauthorized
@ -415,7 +408,7 @@ GET /apis/apps/v1/daemonsets
#### Response
200 (<a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSetList" >}}">DaemonSetList</a>): OK
200 (<a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSetList" >}}">DaemonSetList</a>): OK
401: Unauthorized
@ -434,7 +427,7 @@ POST /apis/apps/v1/namespaces/{namespace}/daemonsets
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>, required
- **body**: <a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>, required
@ -458,11 +451,11 @@ POST /apis/apps/v1/namespaces/{namespace}/daemonsets
#### Response
200 (<a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): OK
201 (<a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): Created
201 (<a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): Created
202 (<a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): Accepted
202 (<a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): Accepted
401: Unauthorized
@ -486,7 +479,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>, required
- **body**: <a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>, required
@ -510,9 +503,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): OK
201 (<a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): Created
201 (<a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): Created
401: Unauthorized
@ -536,7 +529,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>, required
- **body**: <a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>, required
@ -560,9 +553,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): OK
201 (<a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): Created
201 (<a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): Created
401: Unauthorized
@ -615,7 +608,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): OK
401: Unauthorized
@ -668,7 +661,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/daemon-set-v1#DaemonSet" >}}">DaemonSet</a>): OK
401: Unauthorized

58
content/en/docs/reference/kubernetes-api/workload-resources/deployment-v1.md → content/en/docs/reference/kubernetes-api/workloads-resources/deployment-v1.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "Deployment enables declarative updates for Pods and ReplicaSets."
title: "Deployment"
weight: 6
weight: 7
---
`apiVersion: apps/v1`
@ -30,11 +30,11 @@ Deployment enables declarative updates for Pods and ReplicaSets.
Standard object metadata.
- **spec** (<a href="{{< ref "../workload-resources/deployment-v1#DeploymentSpec" >}}">DeploymentSpec</a>)
- **spec** (<a href="{{< ref "../workloads-resources/deployment-v1#DeploymentSpec" >}}">DeploymentSpec</a>)
Specification of the desired behavior of the Deployment.
- **status** (<a href="{{< ref "../workload-resources/deployment-v1#DeploymentStatus" >}}">DeploymentStatus</a>)
- **status** (<a href="{{< ref "../workloads-resources/deployment-v1#DeploymentStatus" >}}">DeploymentStatus</a>)
Most recently observed status of the Deployment.
@ -52,7 +52,7 @@ DeploymentSpec is the specification of the desired behavior of the Deployment.
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.
- **template** (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec</a>), required
- **template** (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec</a>), required
Template describes the pods that will be created.
@ -84,19 +84,19 @@ DeploymentSpec is the specification of the desired behavior of the Deployment.
<a name="RollingUpdateDeployment"></a>
*Spec to control the desired behavior of rolling update.*
- **strategy.rollingUpdate.maxSurge** (IntOrString)
- **strategy.rollingUpdate.maxSurge** (IntOrString)
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.
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.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **strategy.rollingUpdate.maxUnavailable** (IntOrString)
- **strategy.rollingUpdate.maxUnavailable** (IntOrString)
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.
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.
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
<a name="IntOrString"></a>
*IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.*
- **revisionHistoryLimit** (int32)
@ -207,7 +207,7 @@ DeploymentList is a list of Deployments.
Standard list metadata.
- **items** ([]<a href="{{< ref "../workload-resources/deployment-v1#Deployment" >}}">Deployment</a>), required
- **items** ([]<a href="{{< ref "../workloads-resources/deployment-v1#Deployment" >}}">Deployment</a>), required
Items is the list of Deployments.
@ -254,7 +254,7 @@ GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/deployment-v1#Deployment" >}}">Deployment</a>): OK
200 (<a href="{{< ref "../workloads-resources/deployment-v1#Deployment" >}}">Deployment</a>): OK
401: Unauthorized
@ -287,7 +287,7 @@ GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/deployment-v1#Deployment" >}}">Deployment</a>): OK
200 (<a href="{{< ref "../workloads-resources/deployment-v1#Deployment" >}}">Deployment</a>): OK
401: Unauthorized
@ -360,7 +360,7 @@ GET /apis/apps/v1/namespaces/{namespace}/deployments
#### Response
200 (<a href="{{< ref "../workload-resources/deployment-v1#DeploymentList" >}}">DeploymentList</a>): OK
200 (<a href="{{< ref "../workloads-resources/deployment-v1#DeploymentList" >}}">DeploymentList</a>): OK
401: Unauthorized
@ -428,7 +428,7 @@ GET /apis/apps/v1/deployments
#### Response
200 (<a href="{{< ref "../workload-resources/deployment-v1#DeploymentList" >}}">DeploymentList</a>): OK
200 (<a href="{{< ref "../workloads-resources/deployment-v1#DeploymentList" >}}">DeploymentList</a>): OK
401: Unauthorized
@ -447,7 +447,7 @@ POST /apis/apps/v1/namespaces/{namespace}/deployments
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/deployment-v1#Deployment" >}}">Deployment</a>, required
- **body**: <a href="{{< ref "../workloads-resources/deployment-v1#Deployment" >}}">Deployment</a>, required
@ -471,11 +471,11 @@ POST /apis/apps/v1/namespaces/{namespace}/deployments
#### Response
200 (<a href="{{< ref "../workload-resources/deployment-v1#Deployment" >}}">Deployment</a>): OK
200 (<a href="{{< ref "../workloads-resources/deployment-v1#Deployment" >}}">Deployment</a>): OK
201 (<a href="{{< ref "../workload-resources/deployment-v1#Deployment" >}}">Deployment</a>): Created
201 (<a href="{{< ref "../workloads-resources/deployment-v1#Deployment" >}}">Deployment</a>): Created
202 (<a href="{{< ref "../workload-resources/deployment-v1#Deployment" >}}">Deployment</a>): Accepted
202 (<a href="{{< ref "../workloads-resources/deployment-v1#Deployment" >}}">Deployment</a>): Accepted
401: Unauthorized
@ -499,7 +499,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/deployment-v1#Deployment" >}}">Deployment</a>, required
- **body**: <a href="{{< ref "../workloads-resources/deployment-v1#Deployment" >}}">Deployment</a>, required
@ -523,9 +523,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/deployment-v1#Deployment" >}}">Deployment</a>): OK
200 (<a href="{{< ref "../workloads-resources/deployment-v1#Deployment" >}}">Deployment</a>): OK
201 (<a href="{{< ref "../workload-resources/deployment-v1#Deployment" >}}">Deployment</a>): Created
201 (<a href="{{< ref "../workloads-resources/deployment-v1#Deployment" >}}">Deployment</a>): Created
401: Unauthorized
@ -549,7 +549,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/deployment-v1#Deployment" >}}">Deployment</a>, required
- **body**: <a href="{{< ref "../workloads-resources/deployment-v1#Deployment" >}}">Deployment</a>, required
@ -573,9 +573,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/deployment-v1#Deployment" >}}">Deployment</a>): OK
200 (<a href="{{< ref "../workloads-resources/deployment-v1#Deployment" >}}">Deployment</a>): OK
201 (<a href="{{< ref "../workload-resources/deployment-v1#Deployment" >}}">Deployment</a>): Created
201 (<a href="{{< ref "../workloads-resources/deployment-v1#Deployment" >}}">Deployment</a>): Created
401: Unauthorized
@ -628,7 +628,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/deployment-v1#Deployment" >}}">Deployment</a>): OK
200 (<a href="{{< ref "../workloads-resources/deployment-v1#Deployment" >}}">Deployment</a>): OK
401: Unauthorized
@ -681,7 +681,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/deployment-v1#Deployment" >}}">Deployment</a>): OK
200 (<a href="{{< ref "../workloads-resources/deployment-v1#Deployment" >}}">Deployment</a>): OK
401: Unauthorized

426
content/en/docs/reference/kubernetes-api/workload-resources/ephemeral-containers-v1.md → content/en/docs/reference/kubernetes-api/workloads-resources/ephemeral-container.md
View File

@ -1,46 +1,19 @@
---
api_metadata:
apiVersion: "v1"
apiVersion: ""
import: "k8s.io/api/core/v1"
kind: "EphemeralContainers"
kind: "EphemeralContainer"
content_type: "api_reference"
description: "A list of ephemeral containers used with the Pod ephemeralcontainers subresource."
title: "EphemeralContainers"
weight: 2
description: "An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging."
title: "EphemeralContainer"
weight: 3
---
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## EphemeralContainers {#EphemeralContainers}
A list of ephemeral containers used with the Pod ephemeralcontainers subresource.
<hr>
- **apiVersion**: v1
- **kind**: EphemeralContainers
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
- **ephemeralContainers** ([]<a href="{{< ref "../workload-resources/ephemeral-containers-v1#EphemeralContainer" >}}">EphemeralContainer</a>), required
*Patch strategy: merge on key `name`*
A list of ephemeral containers associated with this pod. New ephemeral containers may be appended to this list, but existing ephemeral containers may not be removed or modified.
## EphemeralContainer {#EphemeralContainer}
An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag.
<hr>
@ -55,7 +28,7 @@ An EphemeralContainer is a container that may be added temporarily to an existin
### Image
### Image {#Image}
- **image** (string)
@ -66,7 +39,7 @@ An EphemeralContainer is a container that may be added temporarily to an existin
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
### Entrypoint
### Entrypoint {#Entrypoint}
- **command** ([]string)
@ -81,7 +54,7 @@ An EphemeralContainer is a container that may be added temporarily to an existin
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.
### Environment variables
### Environment variables {#Environment-variables}
- **env** ([]EnvVar)
@ -108,51 +81,51 @@ An EphemeralContainer is a container that may be added temporarily to an existin
<a name="EnvVarSource"></a>
*EnvVarSource represents a source for the value of an EnvVar.*
- **env.valueFrom.configMapKeyRef** (ConfigMapKeySelector)
- **env.valueFrom.configMapKeyRef** (ConfigMapKeySelector)
Selects a key of a ConfigMap.
Selects a key of a ConfigMap.
<a name="ConfigMapKeySelector"></a>
*Selects a key from a ConfigMap.*
<a name="ConfigMapKeySelector"></a>
*Selects a key from a ConfigMap.*
- **env.valueFrom.configMapKeyRef.key** (string), required
- **env.valueFrom.configMapKeyRef.key** (string), required
The key to select.
The key to select.
- **env.valueFrom.configMapKeyRef.name** (string)
- **env.valueFrom.configMapKeyRef.name** (string)
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **env.valueFrom.configMapKeyRef.optional** (boolean)
- **env.valueFrom.configMapKeyRef.optional** (boolean)
Specify whether the ConfigMap or its key must be defined
Specify whether the ConfigMap or its key must be defined
- **env.valueFrom.fieldRef** (<a href="{{< ref "../common-definitions/object-field-selector#ObjectFieldSelector" >}}">ObjectFieldSelector</a>)
- **env.valueFrom.fieldRef** (<a href="{{< ref "../common-definitions/object-field-selector#ObjectFieldSelector" >}}">ObjectFieldSelector</a>)
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.
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.
- **env.valueFrom.resourceFieldRef** (<a href="{{< ref "../common-definitions/resource-field-selector#ResourceFieldSelector" >}}">ResourceFieldSelector</a>)
- **env.valueFrom.resourceFieldRef** (<a href="{{< ref "../common-definitions/resource-field-selector#ResourceFieldSelector" >}}">ResourceFieldSelector</a>)
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.
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.
- **env.valueFrom.secretKeyRef** (SecretKeySelector)
- **env.valueFrom.secretKeyRef** (SecretKeySelector)
Selects a key of a secret in the pod's namespace
Selects a key of a secret in the pod's namespace
<a name="SecretKeySelector"></a>
*SecretKeySelector selects a key of a Secret.*
<a name="SecretKeySelector"></a>
*SecretKeySelector selects a key of a Secret.*
- **env.valueFrom.secretKeyRef.key** (string), required
- **env.valueFrom.secretKeyRef.key** (string), required
The key of the secret to select from. Must be a valid secret key.
The key of the secret to select from. Must be a valid secret key.
- **env.valueFrom.secretKeyRef.name** (string)
- **env.valueFrom.secretKeyRef.name** (string)
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **env.valueFrom.secretKeyRef.optional** (boolean)
- **env.valueFrom.secretKeyRef.optional** (boolean)
Specify whether the Secret or its key must be defined
Specify whether the Secret or its key must be defined
- **envFrom** ([]EnvFromSource)
@ -170,13 +143,13 @@ An EphemeralContainer is a container that may be added temporarily to an existin
The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.*
- **envFrom.configMapRef.name** (string)
- **envFrom.configMapRef.name** (string)
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **envFrom.configMapRef.optional** (boolean)
- **envFrom.configMapRef.optional** (boolean)
Specify whether the ConfigMap must be defined
Specify whether the ConfigMap must be defined
- **envFrom.prefix** (string)
@ -191,15 +164,15 @@ An EphemeralContainer is a container that may be added temporarily to an existin
The contents of the target Secret's Data field will represent the key-value pairs as environment variables.*
- **envFrom.secretRef.name** (string)
- **envFrom.secretRef.name** (string)
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **envFrom.secretRef.optional** (boolean)
- **envFrom.secretRef.optional** (boolean)
Specify whether the Secret must be defined
Specify whether the Secret must be defined
### Volumes
### Volumes {#Volumes}
- **volumeMounts** ([]VolumeMount)
@ -252,7 +225,7 @@ An EphemeralContainer is a container that may be added temporarily to an existin
name must match the name of a persistentVolumeClaim in the pod
### Lifecycle
### Lifecycle {#Lifecycle}
- **terminationMessagePath** (string)
@ -263,7 +236,7 @@ An EphemeralContainer is a container that may be added temporarily to an existin
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.
### Debugging
### Debugging {#Debugging}
- **stdin** (boolean)
@ -278,7 +251,7 @@ An EphemeralContainer is a container that may be added temporarily to an existin
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
### Not allowed
### Not allowed {#Not-allowed}
- **ports** ([]ContainerPort)
@ -317,11 +290,11 @@ An EphemeralContainer is a container that may be added temporarily to an existin
- **resources.limits** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
- **resources.requests** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
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/
- **lifecycle** (Lifecycle)
@ -330,22 +303,122 @@ An EphemeralContainer is a container that may be added temporarily to an existin
<a name="Lifecycle"></a>
*Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.*
- **lifecycle.postStart** (<a href="{{< ref "../workload-resources/pod-v1#Handler" >}}">Handler</a>)
- **lifecycle.postStart** (Handler)
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
- **lifecycle.preStop** (<a href="{{< ref "../workload-resources/pod-v1#Handler" >}}">Handler</a>)
<a name="Handler"></a>
*Handler defines a specific action that should be taken*
- **lifecycle.postStart.exec** (<a href="{{< ref "../common-definitions/exec-action#ExecAction" >}}">ExecAction</a>)
One and only one of the following should be specified. Exec specifies the action to take.
- **lifecycle.postStart.httpGet** (<a href="{{< ref "../common-definitions/http-get-action#HTTPGetAction" >}}">HTTPGetAction</a>)
HTTPGet specifies the http request to perform.
- **lifecycle.postStart.tcpSocket** (<a href="{{< ref "../common-definitions/tcp-socket-action#TCPSocketAction" >}}">TCPSocketAction</a>)
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
- **lifecycle.preStop** (Handler)
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
- **livenessProbe** (<a href="{{< ref "../workload-resources/pod-v1#Probe" >}}">Probe</a>)
<a name="Handler"></a>
*Handler defines a specific action that should be taken*
- **lifecycle.preStop.exec** (<a href="{{< ref "../common-definitions/exec-action#ExecAction" >}}">ExecAction</a>)
One and only one of the following should be specified. Exec specifies the action to take.
- **lifecycle.preStop.httpGet** (<a href="{{< ref "../common-definitions/http-get-action#HTTPGetAction" >}}">HTTPGetAction</a>)
HTTPGet specifies the http request to perform.
- **lifecycle.preStop.tcpSocket** (<a href="{{< ref "../common-definitions/tcp-socket-action#TCPSocketAction" >}}">TCPSocketAction</a>)
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
- **livenessProbe** (Probe)
Probes are not allowed for ephemeral containers.
- **readinessProbe** (<a href="{{< ref "../workload-resources/pod-v1#Probe" >}}">Probe</a>)
<a name="Probe"></a>
*Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.*
- **livenessProbe.exec** (<a href="{{< ref "../common-definitions/exec-action#ExecAction" >}}">ExecAction</a>)
One and only one of the following should be specified. Exec specifies the action to take.
- **livenessProbe.httpGet** (<a href="{{< ref "../common-definitions/http-get-action#HTTPGetAction" >}}">HTTPGetAction</a>)
HTTPGet specifies the http request to perform.
- **livenessProbe.tcpSocket** (<a href="{{< ref "../common-definitions/tcp-socket-action#TCPSocketAction" >}}">TCPSocketAction</a>)
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
- **livenessProbe.initialDelaySeconds** (int32)
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
- **livenessProbe.periodSeconds** (int32)
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
- **livenessProbe.timeoutSeconds** (int32)
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
- **livenessProbe.failureThreshold** (int32)
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- **livenessProbe.successThreshold** (int32)
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.
- **readinessProbe** (Probe)
Probes are not allowed for ephemeral containers.
<a name="Probe"></a>
*Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.*
- **readinessProbe.exec** (<a href="{{< ref "../common-definitions/exec-action#ExecAction" >}}">ExecAction</a>)
One and only one of the following should be specified. Exec specifies the action to take.
- **readinessProbe.httpGet** (<a href="{{< ref "../common-definitions/http-get-action#HTTPGetAction" >}}">HTTPGetAction</a>)
HTTPGet specifies the http request to perform.
- **readinessProbe.tcpSocket** (<a href="{{< ref "../common-definitions/tcp-socket-action#TCPSocketAction" >}}">TCPSocketAction</a>)
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
- **readinessProbe.initialDelaySeconds** (int32)
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
- **readinessProbe.periodSeconds** (int32)
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
- **readinessProbe.timeoutSeconds** (int32)
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
- **readinessProbe.failureThreshold** (int32)
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- **readinessProbe.successThreshold** (int32)
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.
- **securityContext** (SecurityContext)
SecurityContext is not allowed for ephemeral containers.
@ -388,13 +461,13 @@ An EphemeralContainer is a container that may be added temporarily to an existin
<a name="Capabilities"></a>
*Adds and removes POSIX capabilities from running containers.*
- **securityContext.capabilities.add** ([]string)
- **securityContext.capabilities.add** ([]string)
Added capabilities
Added capabilities
- **securityContext.capabilities.drop** ([]string)
- **securityContext.capabilities.drop** ([]string)
Removed capabilities
Removed capabilities
- **securityContext.seccompProfile** (SeccompProfile)
@ -403,15 +476,15 @@ An EphemeralContainer is a container that may be added temporarily to an existin
<a name="SeccompProfile"></a>
*SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.*
- **securityContext.seccompProfile.type** (string), required
- **securityContext.seccompProfile.type** (string), required
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.
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.
- **securityContext.seccompProfile.localhostProfile** (string)
- **securityContext.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".
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".
- **securityContext.seLinuxOptions** (SELinuxOptions)
@ -420,21 +493,21 @@ An EphemeralContainer is a container that may be added temporarily to an existin
<a name="SELinuxOptions"></a>
*SELinuxOptions are the labels to be applied to the container*
- **securityContext.seLinuxOptions.level** (string)
- **securityContext.seLinuxOptions.level** (string)
Level is SELinux level label that applies to the container.
Level is SELinux level label that applies to the container.
- **securityContext.seLinuxOptions.role** (string)
- **securityContext.seLinuxOptions.role** (string)
Role is a SELinux role label that applies to the container.
Role is a SELinux role label that applies to the container.
- **securityContext.seLinuxOptions.type** (string)
- **securityContext.seLinuxOptions.type** (string)
Type is a SELinux type label that applies to the container.
Type is a SELinux type label that applies to the container.
- **securityContext.seLinuxOptions.user** (string)
- **securityContext.seLinuxOptions.user** (string)
User is a SELinux user label that applies to the container.
User is a SELinux user label that applies to the container.
- **securityContext.windowsOptions** (WindowsSecurityContextOptions)
@ -443,167 +516,56 @@ An EphemeralContainer is a container that may be added temporarily to an existin
<a name="WindowsSecurityContextOptions"></a>
*WindowsSecurityContextOptions contain Windows-specific options and credentials.*
- **securityContext.windowsOptions.gmsaCredentialSpec** (string)
- **securityContext.windowsOptions.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.
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.
- **securityContext.windowsOptions.gmsaCredentialSpecName** (string)
- **securityContext.windowsOptions.gmsaCredentialSpecName** (string)
GMSACredentialSpecName is the name of the GMSA credential spec to use.
GMSACredentialSpecName is the name of the GMSA credential spec to use.
- **securityContext.windowsOptions.runAsUserName** (string)
- **securityContext.windowsOptions.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.
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.
- **startupProbe** (<a href="{{< ref "../workload-resources/pod-v1#Probe" >}}">Probe</a>)
- **startupProbe** (Probe)
Probes are not allowed for ephemeral containers.
<a name="Probe"></a>
*Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.*
- **startupProbe.exec** (<a href="{{< ref "../common-definitions/exec-action#ExecAction" >}}">ExecAction</a>)
## Operations {#Operations}
One and only one of the following should be specified. Exec specifies the action to take.
- **startupProbe.httpGet** (<a href="{{< ref "../common-definitions/http-get-action#HTTPGetAction" >}}">HTTPGetAction</a>)
HTTPGet specifies the http request to perform.
<hr>
- **startupProbe.tcpSocket** (<a href="{{< ref "../common-definitions/tcp-socket-action#TCPSocketAction" >}}">TCPSocketAction</a>)
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
- **startupProbe.initialDelaySeconds** (int32)
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
- **startupProbe.periodSeconds** (int32)
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
### `get` read ephemeralcontainers of the specified Pod
- **startupProbe.timeoutSeconds** (int32)
#### HTTP Request
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
GET /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers
- **startupProbe.failureThreshold** (int32)
#### Parameters
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- **startupProbe.successThreshold** (int32)
- **name** (*in path*): string, required
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.
name of the EphemeralContainers
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../workload-resources/ephemeral-containers-v1#EphemeralContainers" >}}">EphemeralContainers</a>): OK
401: Unauthorized
### `update` replace ephemeralcontainers of the specified Pod
#### HTTP Request
PUT /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers
#### Parameters
- **name** (*in path*): string, required
name of the EphemeralContainers
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/ephemeral-containers-v1#EphemeralContainers" >}}">EphemeralContainers</a>, required
- **dryRun** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
- **fieldManager** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../workload-resources/ephemeral-containers-v1#EphemeralContainers" >}}">EphemeralContainers</a>): OK
201 (<a href="{{< ref "../workload-resources/ephemeral-containers-v1#EphemeralContainers" >}}">EphemeralContainers</a>): Created
401: Unauthorized
### `patch` partially update ephemeralcontainers of the specified Pod
#### HTTP Request
PATCH /api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers
#### Parameters
- **name** (*in path*): string, required
name of the EphemeralContainers
- **namespace** (*in path*): string, required
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>, required
- **dryRun** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
- **fieldManager** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
- **force** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../workload-resources/ephemeral-containers-v1#EphemeralContainers" >}}">EphemeralContainers</a>): OK
401: Unauthorized

40
content/en/docs/reference/kubernetes-api/workload-resources/horizontal-pod-autoscaler-v1.md → content/en/docs/reference/kubernetes-api/workloads-resources/horizontal-pod-autoscaler-v1.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "configuration of a horizontal pod autoscaler."
title: "HorizontalPodAutoscaler"
weight: 12
weight: 14
---
`apiVersion: autoscaling/v1`
@ -30,11 +30,11 @@ configuration of a horizontal pod autoscaler.
Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscalerSpec" >}}">HorizontalPodAutoscalerSpec</a>)
- **spec** (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscalerSpec" >}}">HorizontalPodAutoscalerSpec</a>)
behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
- **status** (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscalerStatus" >}}">HorizontalPodAutoscalerStatus</a>)
- **status** (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscalerStatus" >}}">HorizontalPodAutoscalerStatus</a>)
current information about the autoscaler.
@ -132,7 +132,7 @@ list of horizontal pod autoscaler objects.
Standard list metadata.
- **items** ([]<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>), required
- **items** ([]<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>), required
list of horizontal pod autoscaler objects.
@ -179,7 +179,7 @@ GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
401: Unauthorized
@ -212,7 +212,7 @@ GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
401: Unauthorized
@ -285,7 +285,7 @@ GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscalerList" >}}">HorizontalPodAutoscalerList</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscalerList" >}}">HorizontalPodAutoscalerList</a>): OK
401: Unauthorized
@ -353,7 +353,7 @@ GET /apis/autoscaling/v1/horizontalpodautoscalers
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscalerList" >}}">HorizontalPodAutoscalerList</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscalerList" >}}">HorizontalPodAutoscalerList</a>): OK
401: Unauthorized
@ -372,7 +372,7 @@ POST /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>, required
- **body**: <a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>, required
@ -396,11 +396,11 @@ POST /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
201 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): Created
201 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): Created
202 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): Accepted
202 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): Accepted
401: Unauthorized
@ -424,7 +424,7 @@ PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>, required
- **body**: <a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>, required
@ -448,9 +448,9 @@ PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
201 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): Created
201 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): Created
401: Unauthorized
@ -474,7 +474,7 @@ PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>, required
- **body**: <a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>, required
@ -498,9 +498,9 @@ PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
201 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): Created
201 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): Created
401: Unauthorized
@ -553,7 +553,7 @@ PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
401: Unauthorized
@ -606,7 +606,7 @@ PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
401: Unauthorized

472
content/en/docs/reference/kubernetes-api/workload-resources/horizontal-pod-autoscaler-v2beta2.md → content/en/docs/reference/kubernetes-api/workloads-resources/horizontal-pod-autoscaler-v2beta2.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified."
title: "HorizontalPodAutoscaler v2beta2"
weight: 13
weight: 15
---
`apiVersion: autoscaling/v2beta2`
@ -30,11 +30,11 @@ HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, wh
metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscalerSpec" >}}">HorizontalPodAutoscalerSpec</a>)
- **spec** (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscalerSpec" >}}">HorizontalPodAutoscalerSpec</a>)
spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
- **status** (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscalerStatus" >}}">HorizontalPodAutoscalerStatus</a>)
- **status** (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscalerStatus" >}}">HorizontalPodAutoscalerStatus</a>)
status is the current information about the autoscaler.
@ -89,32 +89,32 @@ HorizontalPodAutoscalerSpec describes the desired functionality of the Horizonta
<a name="HPAScalingRules"></a>
*HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.*
- **behavior.scaleDown.policies** ([]HPAScalingPolicy)
- **behavior.scaleDown.policies** ([]HPAScalingPolicy)
policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
<a name="HPAScalingPolicy"></a>
*HPAScalingPolicy is a single policy which must hold true for a specified past interval.*
<a name="HPAScalingPolicy"></a>
*HPAScalingPolicy is a single policy which must hold true for a specified past interval.*
- **behavior.scaleDown.policies.type** (string), required
- **behavior.scaleDown.policies.type** (string), required
Type is used to specify the scaling policy.
Type is used to specify the scaling policy.
- **behavior.scaleDown.policies.value** (int32), required
- **behavior.scaleDown.policies.value** (int32), required
Value contains the amount of change which is permitted by the policy. It must be greater than zero
Value contains the amount of change which is permitted by the policy. It must be greater than zero
- **behavior.scaleDown.policies.periodSeconds** (int32), required
- **behavior.scaleDown.policies.periodSeconds** (int32), required
PeriodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
PeriodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
- **behavior.scaleDown.selectPolicy** (string)
- **behavior.scaleDown.selectPolicy** (string)
selectPolicy is used to specify which policy should be used. If not set, the default value MaxPolicySelect is used.
selectPolicy is used to specify which policy should be used. If not set, the default value MaxPolicySelect is used.
- **behavior.scaleDown.stabilizationWindowSeconds** (int32)
- **behavior.scaleDown.stabilizationWindowSeconds** (int32)
StabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).
StabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).
- **behavior.scaleUp** (HPAScalingRules)
@ -126,32 +126,32 @@ HorizontalPodAutoscalerSpec describes the desired functionality of the Horizonta
<a name="HPAScalingRules"></a>
*HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.*
- **behavior.scaleUp.policies** ([]HPAScalingPolicy)
- **behavior.scaleUp.policies** ([]HPAScalingPolicy)
policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
<a name="HPAScalingPolicy"></a>
*HPAScalingPolicy is a single policy which must hold true for a specified past interval.*
<a name="HPAScalingPolicy"></a>
*HPAScalingPolicy is a single policy which must hold true for a specified past interval.*
- **behavior.scaleUp.policies.type** (string), required
- **behavior.scaleUp.policies.type** (string), required
Type is used to specify the scaling policy.
Type is used to specify the scaling policy.
- **behavior.scaleUp.policies.value** (int32), required
- **behavior.scaleUp.policies.value** (int32), required
Value contains the amount of change which is permitted by the policy. It must be greater than zero
Value contains the amount of change which is permitted by the policy. It must be greater than zero
- **behavior.scaleUp.policies.periodSeconds** (int32), required
- **behavior.scaleUp.policies.periodSeconds** (int32), required
PeriodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
PeriodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
- **behavior.scaleUp.selectPolicy** (string)
- **behavior.scaleUp.selectPolicy** (string)
selectPolicy is used to specify which policy should be used. If not set, the default value MaxPolicySelect is used.
selectPolicy is used to specify which policy should be used. If not set, the default value MaxPolicySelect is used.
- **behavior.scaleUp.stabilizationWindowSeconds** (int32)
- **behavior.scaleUp.stabilizationWindowSeconds** (int32)
StabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).
StabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).
- **metrics** ([]MetricSpec)
@ -171,36 +171,36 @@ HorizontalPodAutoscalerSpec describes the desired functionality of the Horizonta
<a name="ContainerResourceMetricSource"></a>
*ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.*
- **metrics.containerResource.container** (string), required
- **metrics.containerResource.container** (string), required
container is the name of the container in the pods of the scaling target
container is the name of the container in the pods of the scaling target
- **metrics.containerResource.name** (string), required
- **metrics.containerResource.name** (string), required
name is the name of the resource in question.
name is the name of the resource in question.
- **metrics.containerResource.target** (MetricTarget), required
- **metrics.containerResource.target** (MetricTarget), required
target specifies the target value for the given metric
target specifies the target value for the given metric
<a name="MetricTarget"></a>
*MetricTarget defines the target value, average value, or average utilization of a specific metric*
<a name="MetricTarget"></a>
*MetricTarget defines the target value, average value, or average utilization of a specific metric*
- **metrics.containerResource.target.type** (string), required
- **metrics.containerResource.target.type** (string), required
type represents whether the metric type is Utilization, Value, or AverageValue
type represents whether the metric type is Utilization, Value, or AverageValue
- **metrics.containerResource.target.averageUtilization** (int32)
- **metrics.containerResource.target.averageUtilization** (int32)
averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
- **metrics.containerResource.target.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **metrics.containerResource.target.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
- **metrics.containerResource.target.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **metrics.containerResource.target.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
value is the target value of the metric (as a quantity).
value is the target value of the metric (as a quantity).
- **metrics.external** (ExternalMetricSource)
@ -209,43 +209,43 @@ HorizontalPodAutoscalerSpec describes the desired functionality of the Horizonta
<a name="ExternalMetricSource"></a>
*ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).*
- **metrics.external.metric** (MetricIdentifier), required
- **metrics.external.metric** (MetricIdentifier), required
metric identifies the target metric by name and selector
metric identifies the target metric by name and selector
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
- **metrics.external.metric.name** (string), required
- **metrics.external.metric.name** (string), required
name is the name of the given metric
name is the name of the given metric
- **metrics.external.metric.selector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
- **metrics.external.metric.selector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- **metrics.external.target** (MetricTarget), required
- **metrics.external.target** (MetricTarget), required
target specifies the target value for the given metric
target specifies the target value for the given metric
<a name="MetricTarget"></a>
*MetricTarget defines the target value, average value, or average utilization of a specific metric*
<a name="MetricTarget"></a>
*MetricTarget defines the target value, average value, or average utilization of a specific metric*
- **metrics.external.target.type** (string), required
- **metrics.external.target.type** (string), required
type represents whether the metric type is Utilization, Value, or AverageValue
type represents whether the metric type is Utilization, Value, or AverageValue
- **metrics.external.target.averageUtilization** (int32)
- **metrics.external.target.averageUtilization** (int32)
averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
- **metrics.external.target.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **metrics.external.target.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
- **metrics.external.target.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **metrics.external.target.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
value is the target value of the metric (as a quantity).
value is the target value of the metric (as a quantity).
- **metrics.object** (ObjectMetricSource)
@ -254,61 +254,61 @@ HorizontalPodAutoscalerSpec describes the desired functionality of the Horizonta
<a name="ObjectMetricSource"></a>
*ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).*
- **metrics.object.describedObject** (CrossVersionObjectReference), required
- **metrics.object.describedObject** (CrossVersionObjectReference), required
<a name="CrossVersionObjectReference"></a>
*CrossVersionObjectReference contains enough information to let you identify the referred resource.*
<a name="CrossVersionObjectReference"></a>
*CrossVersionObjectReference contains enough information to let you identify the referred resource.*
- **metrics.object.describedObject.kind** (string), required
- **metrics.object.describedObject.kind** (string), required
Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
- **metrics.object.describedObject.name** (string), required
- **metrics.object.describedObject.name** (string), required
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
- **metrics.object.describedObject.apiVersion** (string)
- **metrics.object.describedObject.apiVersion** (string)
API version of the referent
API version of the referent
- **metrics.object.metric** (MetricIdentifier), required
- **metrics.object.metric** (MetricIdentifier), required
metric identifies the target metric by name and selector
metric identifies the target metric by name and selector
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
- **metrics.object.metric.name** (string), required
- **metrics.object.metric.name** (string), required
name is the name of the given metric
name is the name of the given metric
- **metrics.object.metric.selector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
- **metrics.object.metric.selector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- **metrics.object.target** (MetricTarget), required
- **metrics.object.target** (MetricTarget), required
target specifies the target value for the given metric
target specifies the target value for the given metric
<a name="MetricTarget"></a>
*MetricTarget defines the target value, average value, or average utilization of a specific metric*
<a name="MetricTarget"></a>
*MetricTarget defines the target value, average value, or average utilization of a specific metric*
- **metrics.object.target.type** (string), required
- **metrics.object.target.type** (string), required
type represents whether the metric type is Utilization, Value, or AverageValue
type represents whether the metric type is Utilization, Value, or AverageValue
- **metrics.object.target.averageUtilization** (int32)
- **metrics.object.target.averageUtilization** (int32)
averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
- **metrics.object.target.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **metrics.object.target.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
- **metrics.object.target.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **metrics.object.target.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
value is the target value of the metric (as a quantity).
value is the target value of the metric (as a quantity).
- **metrics.pods** (PodsMetricSource)
@ -317,43 +317,43 @@ HorizontalPodAutoscalerSpec describes the desired functionality of the Horizonta
<a name="PodsMetricSource"></a>
*PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.*
- **metrics.pods.metric** (MetricIdentifier), required
- **metrics.pods.metric** (MetricIdentifier), required
metric identifies the target metric by name and selector
metric identifies the target metric by name and selector
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
- **metrics.pods.metric.name** (string), required
- **metrics.pods.metric.name** (string), required
name is the name of the given metric
name is the name of the given metric
- **metrics.pods.metric.selector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
- **metrics.pods.metric.selector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- **metrics.pods.target** (MetricTarget), required
- **metrics.pods.target** (MetricTarget), required
target specifies the target value for the given metric
target specifies the target value for the given metric
<a name="MetricTarget"></a>
*MetricTarget defines the target value, average value, or average utilization of a specific metric*
<a name="MetricTarget"></a>
*MetricTarget defines the target value, average value, or average utilization of a specific metric*
- **metrics.pods.target.type** (string), required
- **metrics.pods.target.type** (string), required
type represents whether the metric type is Utilization, Value, or AverageValue
type represents whether the metric type is Utilization, Value, or AverageValue
- **metrics.pods.target.averageUtilization** (int32)
- **metrics.pods.target.averageUtilization** (int32)
averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
- **metrics.pods.target.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **metrics.pods.target.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
- **metrics.pods.target.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **metrics.pods.target.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
value is the target value of the metric (as a quantity).
value is the target value of the metric (as a quantity).
- **metrics.resource** (ResourceMetricSource)
@ -362,32 +362,32 @@ HorizontalPodAutoscalerSpec describes the desired functionality of the Horizonta
<a name="ResourceMetricSource"></a>
*ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.*
- **metrics.resource.name** (string), required
- **metrics.resource.name** (string), required
name is the name of the resource in question.
name is the name of the resource in question.
- **metrics.resource.target** (MetricTarget), required
- **metrics.resource.target** (MetricTarget), required
target specifies the target value for the given metric
target specifies the target value for the given metric
<a name="MetricTarget"></a>
*MetricTarget defines the target value, average value, or average utilization of a specific metric*
<a name="MetricTarget"></a>
*MetricTarget defines the target value, average value, or average utilization of a specific metric*
- **metrics.resource.target.type** (string), required
- **metrics.resource.target.type** (string), required
type represents whether the metric type is Utilization, Value, or AverageValue
type represents whether the metric type is Utilization, Value, or AverageValue
- **metrics.resource.target.averageUtilization** (int32)
- **metrics.resource.target.averageUtilization** (int32)
averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
- **metrics.resource.target.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **metrics.resource.target.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
- **metrics.resource.target.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **metrics.resource.target.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
value is the target value of the metric (as a quantity).
value is the target value of the metric (as a quantity).
@ -455,32 +455,32 @@ HorizontalPodAutoscalerStatus describes the current status of a horizontal pod a
<a name="ContainerResourceMetricStatus"></a>
*ContainerResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.*
- **currentMetrics.containerResource.container** (string), required
- **currentMetrics.containerResource.container** (string), required
Container is the name of the container in the pods of the scaling target
Container is the name of the container in the pods of the scaling target
- **currentMetrics.containerResource.current** (MetricValueStatus), required
- **currentMetrics.containerResource.current** (MetricValueStatus), required
current contains the current value for the given metric
current contains the current value for the given metric
<a name="MetricValueStatus"></a>
*MetricValueStatus holds the current value for a metric*
<a name="MetricValueStatus"></a>
*MetricValueStatus holds the current value for a metric*
- **currentMetrics.containerResource.current.averageUtilization** (int32)
- **currentMetrics.containerResource.current.averageUtilization** (int32)
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
- **currentMetrics.containerResource.current.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **currentMetrics.containerResource.current.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
- **currentMetrics.containerResource.current.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **currentMetrics.containerResource.current.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
value is the current value of the metric (as a quantity).
value is the current value of the metric (as a quantity).
- **currentMetrics.containerResource.name** (string), required
- **currentMetrics.containerResource.name** (string), required
Name is the name of the resource in question.
Name is the name of the resource in question.
- **currentMetrics.external** (ExternalMetricStatus)
@ -489,39 +489,39 @@ HorizontalPodAutoscalerStatus describes the current status of a horizontal pod a
<a name="ExternalMetricStatus"></a>
*ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.*
- **currentMetrics.external.current** (MetricValueStatus), required
- **currentMetrics.external.current** (MetricValueStatus), required
current contains the current value for the given metric
current contains the current value for the given metric
<a name="MetricValueStatus"></a>
*MetricValueStatus holds the current value for a metric*
<a name="MetricValueStatus"></a>
*MetricValueStatus holds the current value for a metric*
- **currentMetrics.external.current.averageUtilization** (int32)
- **currentMetrics.external.current.averageUtilization** (int32)
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
- **currentMetrics.external.current.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **currentMetrics.external.current.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
- **currentMetrics.external.current.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **currentMetrics.external.current.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
value is the current value of the metric (as a quantity).
value is the current value of the metric (as a quantity).
- **currentMetrics.external.metric** (MetricIdentifier), required
- **currentMetrics.external.metric** (MetricIdentifier), required
metric identifies the target metric by name and selector
metric identifies the target metric by name and selector
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
- **currentMetrics.external.metric.name** (string), required
- **currentMetrics.external.metric.name** (string), required
name is the name of the given metric
name is the name of the given metric
- **currentMetrics.external.metric.selector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
- **currentMetrics.external.metric.selector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- **currentMetrics.object** (ObjectMetricStatus)
@ -530,57 +530,57 @@ HorizontalPodAutoscalerStatus describes the current status of a horizontal pod a
<a name="ObjectMetricStatus"></a>
*ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).*
- **currentMetrics.object.current** (MetricValueStatus), required
- **currentMetrics.object.current** (MetricValueStatus), required
current contains the current value for the given metric
current contains the current value for the given metric
<a name="MetricValueStatus"></a>
*MetricValueStatus holds the current value for a metric*
<a name="MetricValueStatus"></a>
*MetricValueStatus holds the current value for a metric*
- **currentMetrics.object.current.averageUtilization** (int32)
- **currentMetrics.object.current.averageUtilization** (int32)
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
- **currentMetrics.object.current.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **currentMetrics.object.current.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
- **currentMetrics.object.current.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **currentMetrics.object.current.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
value is the current value of the metric (as a quantity).
value is the current value of the metric (as a quantity).
- **currentMetrics.object.describedObject** (CrossVersionObjectReference), required
- **currentMetrics.object.describedObject** (CrossVersionObjectReference), required
<a name="CrossVersionObjectReference"></a>
*CrossVersionObjectReference contains enough information to let you identify the referred resource.*
<a name="CrossVersionObjectReference"></a>
*CrossVersionObjectReference contains enough information to let you identify the referred resource.*
- **currentMetrics.object.describedObject.kind** (string), required
- **currentMetrics.object.describedObject.kind** (string), required
Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
- **currentMetrics.object.describedObject.name** (string), required
- **currentMetrics.object.describedObject.name** (string), required
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
- **currentMetrics.object.describedObject.apiVersion** (string)
- **currentMetrics.object.describedObject.apiVersion** (string)
API version of the referent
API version of the referent
- **currentMetrics.object.metric** (MetricIdentifier), required
- **currentMetrics.object.metric** (MetricIdentifier), required
metric identifies the target metric by name and selector
metric identifies the target metric by name and selector
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
- **currentMetrics.object.metric.name** (string), required
- **currentMetrics.object.metric.name** (string), required
name is the name of the given metric
name is the name of the given metric
- **currentMetrics.object.metric.selector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
- **currentMetrics.object.metric.selector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- **currentMetrics.pods** (PodsMetricStatus)
@ -589,39 +589,39 @@ HorizontalPodAutoscalerStatus describes the current status of a horizontal pod a
<a name="PodsMetricStatus"></a>
*PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).*
- **currentMetrics.pods.current** (MetricValueStatus), required
- **currentMetrics.pods.current** (MetricValueStatus), required
current contains the current value for the given metric
current contains the current value for the given metric
<a name="MetricValueStatus"></a>
*MetricValueStatus holds the current value for a metric*
<a name="MetricValueStatus"></a>
*MetricValueStatus holds the current value for a metric*
- **currentMetrics.pods.current.averageUtilization** (int32)
- **currentMetrics.pods.current.averageUtilization** (int32)
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
- **currentMetrics.pods.current.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **currentMetrics.pods.current.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
- **currentMetrics.pods.current.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **currentMetrics.pods.current.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
value is the current value of the metric (as a quantity).
value is the current value of the metric (as a quantity).
- **currentMetrics.pods.metric** (MetricIdentifier), required
- **currentMetrics.pods.metric** (MetricIdentifier), required
metric identifies the target metric by name and selector
metric identifies the target metric by name and selector
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
<a name="MetricIdentifier"></a>
*MetricIdentifier defines the name and optionally selector for a metric*
- **currentMetrics.pods.metric.name** (string), required
- **currentMetrics.pods.metric.name** (string), required
name is the name of the given metric
name is the name of the given metric
- **currentMetrics.pods.metric.selector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
- **currentMetrics.pods.metric.selector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
- **currentMetrics.resource** (ResourceMetricStatus)
@ -630,28 +630,28 @@ HorizontalPodAutoscalerStatus describes the current status of a horizontal pod a
<a name="ResourceMetricStatus"></a>
*ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.*
- **currentMetrics.resource.current** (MetricValueStatus), required
- **currentMetrics.resource.current** (MetricValueStatus), required
current contains the current value for the given metric
current contains the current value for the given metric
<a name="MetricValueStatus"></a>
*MetricValueStatus holds the current value for a metric*
<a name="MetricValueStatus"></a>
*MetricValueStatus holds the current value for a metric*
- **currentMetrics.resource.current.averageUtilization** (int32)
- **currentMetrics.resource.current.averageUtilization** (int32)
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
- **currentMetrics.resource.current.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **currentMetrics.resource.current.averageValue** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
- **currentMetrics.resource.current.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
- **currentMetrics.resource.current.value** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
value is the current value of the metric (as a quantity).
value is the current value of the metric (as a quantity).
- **currentMetrics.resource.name** (string), required
- **currentMetrics.resource.name** (string), required
Name is the name of the resource in question.
Name is the name of the resource in question.
- **lastScaleTime** (Time)
@ -684,7 +684,7 @@ HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects.
metadata is the standard list metadata.
- **items** ([]<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>), required
- **items** ([]<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>), required
items is the list of horizontal pod autoscaler objects.
@ -731,7 +731,7 @@ GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{n
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
401: Unauthorized
@ -764,7 +764,7 @@ GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{n
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
401: Unauthorized
@ -837,7 +837,7 @@ GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscalerList" >}}">HorizontalPodAutoscalerList</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscalerList" >}}">HorizontalPodAutoscalerList</a>): OK
401: Unauthorized
@ -905,7 +905,7 @@ GET /apis/autoscaling/v2beta2/horizontalpodautoscalers
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscalerList" >}}">HorizontalPodAutoscalerList</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscalerList" >}}">HorizontalPodAutoscalerList</a>): OK
401: Unauthorized
@ -924,7 +924,7 @@ POST /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>, required
- **body**: <a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>, required
@ -948,11 +948,11 @@ POST /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
201 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): Created
201 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): Created
202 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): Accepted
202 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): Accepted
401: Unauthorized
@ -976,7 +976,7 @@ PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{n
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>, required
- **body**: <a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>, required
@ -1000,9 +1000,9 @@ PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{n
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
201 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): Created
201 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): Created
401: Unauthorized
@ -1026,7 +1026,7 @@ PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{n
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>, required
- **body**: <a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>, required
@ -1050,9 +1050,9 @@ PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{n
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
201 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): Created
201 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): Created
401: Unauthorized
@ -1105,7 +1105,7 @@ PATCH /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
401: Unauthorized
@ -1158,7 +1158,7 @@ PATCH /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/
#### Response
200 (<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
200 (<a href="{{< ref "../workloads-resources/horizontal-pod-autoscaler-v2beta2#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>): OK
401: Unauthorized

68
content/en/docs/reference/kubernetes-api/workload-resources/job-v1.md → content/en/docs/reference/kubernetes-api/workloads-resources/job-v1.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "Job represents the configuration of a single job."
title: "Job"
weight: 10
weight: 11
---
`apiVersion: batch/v1`
@ -30,11 +30,11 @@ Job represents the configuration of a single job.
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../workload-resources/job-v1#JobSpec" >}}">JobSpec</a>)
- **spec** (<a href="{{< ref "../workloads-resources/job-v1#JobSpec" >}}">JobSpec</a>)
Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="{{< ref "../workload-resources/job-v1#JobStatus" >}}">JobStatus</a>)
- **status** (<a href="{{< ref "../workloads-resources/job-v1#JobStatus" >}}">JobStatus</a>)
Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@ -53,7 +53,7 @@ JobSpec describes how the job execution will look like.
### Replicas
- **template** (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec</a>), required
- **template** (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec</a>), required
Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
@ -68,32 +68,18 @@ JobSpec describes how the job execution will look like.
Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
- **completionMode** (string)
CompletionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`.
`NonIndexed` means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other.
`Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5.
This field is alpha-level and is only honored by servers that enable the IndexedJob feature gate. More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, the controller skips updates for the Job.
- **backoffLimit** (int32)
Specifies the number of retries before marking this job failed. Defaults to 6
- **activeDeadlineSeconds** (int64)
Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again.
Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer
- **ttlSecondsAfterFinished** (int32)
ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature.
- **suspend** (boolean)
Suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. This is an alpha field and requires the SuspendJob feature gate to be enabled; otherwise this field may not be set to true. Defaults to false.
### Selector
@ -115,7 +101,7 @@ JobStatus represents the current state of a Job.
- **startTime** (Time)
Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC.
Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
<a name="Time"></a>
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
@ -139,17 +125,11 @@ JobStatus represents the current state of a Job.
The number of pods which reached phase Succeeded.
- **completedIndexes** (string)
CompletedIndexes holds the completed indexes when .spec.completionMode = "Indexed" in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7".
- **conditions** ([]JobCondition)
*Patch strategy: merge on key `type`*
*Atomic: will be replaced during a merge*
The latest available observations of an object's current state. When a Job fails, one of the conditions will have type "Failed" and status true. When a Job is suspended, one of the conditions will have type "Suspended" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type "Complete" and status true. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
The latest available observations of an object's current state. When a job fails, one of the conditions will have type == "Failed". More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
<a name="JobCondition"></a>
*JobCondition describes current state of a job.*
@ -204,7 +184,7 @@ JobList is a collection of jobs.
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="{{< ref "../workload-resources/job-v1#Job" >}}">Job</a>), required
- **items** ([]<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job</a>), required
items is the list of Jobs.
@ -251,7 +231,7 @@ GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/job-v1#Job" >}}">Job</a>): OK
200 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job</a>): OK
401: Unauthorized
@ -284,7 +264,7 @@ GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/job-v1#Job" >}}">Job</a>): OK
200 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job</a>): OK
401: Unauthorized
@ -357,7 +337,7 @@ GET /apis/batch/v1/namespaces/{namespace}/jobs
#### Response
200 (<a href="{{< ref "../workload-resources/job-v1#JobList" >}}">JobList</a>): OK
200 (<a href="{{< ref "../workloads-resources/job-v1#JobList" >}}">JobList</a>): OK
401: Unauthorized
@ -425,7 +405,7 @@ GET /apis/batch/v1/jobs
#### Response
200 (<a href="{{< ref "../workload-resources/job-v1#JobList" >}}">JobList</a>): OK
200 (<a href="{{< ref "../workloads-resources/job-v1#JobList" >}}">JobList</a>): OK
401: Unauthorized
@ -444,7 +424,7 @@ POST /apis/batch/v1/namespaces/{namespace}/jobs
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/job-v1#Job" >}}">Job</a>, required
- **body**: <a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job</a>, required
@ -468,11 +448,11 @@ POST /apis/batch/v1/namespaces/{namespace}/jobs
#### Response
200 (<a href="{{< ref "../workload-resources/job-v1#Job" >}}">Job</a>): OK
200 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job</a>): OK
201 (<a href="{{< ref "../workload-resources/job-v1#Job" >}}">Job</a>): Created
201 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job</a>): Created
202 (<a href="{{< ref "../workload-resources/job-v1#Job" >}}">Job</a>): Accepted
202 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job</a>): Accepted
401: Unauthorized
@ -496,7 +476,7 @@ PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/job-v1#Job" >}}">Job</a>, required
- **body**: <a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job</a>, required
@ -520,9 +500,9 @@ PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/job-v1#Job" >}}">Job</a>): OK
200 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job</a>): OK
201 (<a href="{{< ref "../workload-resources/job-v1#Job" >}}">Job</a>): Created
201 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job</a>): Created
401: Unauthorized
@ -546,7 +526,7 @@ PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/job-v1#Job" >}}">Job</a>, required
- **body**: <a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job</a>, required
@ -570,9 +550,9 @@ PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/job-v1#Job" >}}">Job</a>): OK
200 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job</a>): OK
201 (<a href="{{< ref "../workload-resources/job-v1#Job" >}}">Job</a>): Created
201 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job</a>): Created
401: Unauthorized
@ -625,7 +605,7 @@ PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/job-v1#Job" >}}">Job</a>): OK
200 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job</a>): OK
401: Unauthorized
@ -678,7 +658,7 @@ PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/job-v1#Job" >}}">Job</a>): OK
200 (<a href="{{< ref "../workloads-resources/job-v1#Job" >}}">Job</a>): OK
401: Unauthorized

34
content/en/docs/reference/kubernetes-api/workload-resources/pod-template-v1.md → content/en/docs/reference/kubernetes-api/workloads-resources/pod-template-v1.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "PodTemplate describes a template for creating copies of a predefined pod."
title: "PodTemplate"
weight: 3
weight: 4
---
`apiVersion: v1`
@ -30,7 +30,7 @@ PodTemplate describes a template for creating copies of a predefined pod.
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **template** (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec</a>)
- **template** (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec</a>)
Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@ -48,7 +48,7 @@ PodTemplateSpec describes the data a pod should have when created from a templat
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../workload-resources/pod-v1#PodSpec" >}}">PodSpec</a>)
- **spec** (<a href="{{< ref "../workloads-resources/pod-v1#PodSpec" >}}">PodSpec</a>)
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
@ -72,7 +72,7 @@ PodTemplateList is a list of PodTemplates.
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>), required
- **items** ([]<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>), required
List of pod templates
@ -119,7 +119,7 @@ GET /api/v1/namespaces/{namespace}/podtemplates/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): OK
200 (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): OK
401: Unauthorized
@ -192,7 +192,7 @@ GET /api/v1/namespaces/{namespace}/podtemplates
#### Response
200 (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplateList" >}}">PodTemplateList</a>): OK
200 (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplateList" >}}">PodTemplateList</a>): OK
401: Unauthorized
@ -260,7 +260,7 @@ GET /api/v1/podtemplates
#### Response
200 (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplateList" >}}">PodTemplateList</a>): OK
200 (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplateList" >}}">PodTemplateList</a>): OK
401: Unauthorized
@ -279,7 +279,7 @@ POST /api/v1/namespaces/{namespace}/podtemplates
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>, required
- **body**: <a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>, required
@ -303,11 +303,11 @@ POST /api/v1/namespaces/{namespace}/podtemplates
#### Response
200 (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): OK
200 (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): OK
201 (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): Created
201 (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): Created
202 (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): Accepted
202 (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): Accepted
401: Unauthorized
@ -331,7 +331,7 @@ PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>, required
- **body**: <a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>, required
@ -355,9 +355,9 @@ PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): OK
200 (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): OK
201 (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): Created
201 (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): Created
401: Unauthorized
@ -410,7 +410,7 @@ PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): OK
200 (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): OK
401: Unauthorized
@ -463,9 +463,9 @@ DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): OK
200 (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): OK
202 (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): Accepted
202 (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplate" >}}">PodTemplate</a>): Accepted
401: Unauthorized

1270
content/en/docs/reference/kubernetes-api/workloads-resources/pod-v1.md Normal file
View File

File diff suppressed because it is too large Load Diff

24
content/en/docs/reference/kubernetes-api/workload-resources/priority-class-v1.md → content/en/docs/reference/kubernetes-api/workloads-resources/priority-class-v1.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "PriorityClass defines mapping from a priority class name to the priority integer value."
title: "PriorityClass"
weight: 14
weight: 16
---
`apiVersion: scheduling.k8s.io/v1`
@ -66,7 +66,7 @@ PriorityClassList is a collection of priority classes.
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>), required
- **items** ([]<a href="{{< ref "../workloads-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>), required
items is the list of PriorityClasses
@ -108,7 +108,7 @@ GET /apis/scheduling.k8s.io/v1/priorityclasses/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): OK
200 (<a href="{{< ref "../workloads-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): OK
401: Unauthorized
@ -176,7 +176,7 @@ GET /apis/scheduling.k8s.io/v1/priorityclasses
#### Response
200 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClassList" >}}">PriorityClassList</a>): OK
200 (<a href="{{< ref "../workloads-resources/priority-class-v1#PriorityClassList" >}}">PriorityClassList</a>): OK
401: Unauthorized
@ -190,7 +190,7 @@ POST /apis/scheduling.k8s.io/v1/priorityclasses
#### Parameters
- **body**: <a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>, required
- **body**: <a href="{{< ref "../workloads-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>, required
@ -214,11 +214,11 @@ POST /apis/scheduling.k8s.io/v1/priorityclasses
#### Response
200 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): OK
200 (<a href="{{< ref "../workloads-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): OK
201 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): Created
201 (<a href="{{< ref "../workloads-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): Created
202 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): Accepted
202 (<a href="{{< ref "../workloads-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): Accepted
401: Unauthorized
@ -237,7 +237,7 @@ PUT /apis/scheduling.k8s.io/v1/priorityclasses/{name}
name of the PriorityClass
- **body**: <a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>, required
- **body**: <a href="{{< ref "../workloads-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>, required
@ -261,9 +261,9 @@ PUT /apis/scheduling.k8s.io/v1/priorityclasses/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): OK
200 (<a href="{{< ref "../workloads-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): OK
201 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): Created
201 (<a href="{{< ref "../workloads-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): Created
401: Unauthorized
@ -311,7 +311,7 @@ PATCH /apis/scheduling.k8s.io/v1/priorityclasses/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): OK
200 (<a href="{{< ref "../workloads-resources/priority-class-v1#PriorityClass" >}}">PriorityClass</a>): OK
401: Unauthorized

42
content/en/docs/reference/kubernetes-api/workload-resources/replica-set-v1.md → content/en/docs/reference/kubernetes-api/workloads-resources/replica-set-v1.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "ReplicaSet ensures that a specified number of pod replicas are running at any given time."
title: "ReplicaSet"
weight: 5
weight: 6
---
`apiVersion: apps/v1`
@ -30,11 +30,11 @@ ReplicaSet ensures that a specified number of pod replicas are running at any gi
If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSetSpec" >}}">ReplicaSetSpec</a>)
- **spec** (<a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSetSpec" >}}">ReplicaSetSpec</a>)
Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSetStatus" >}}">ReplicaSetStatus</a>)
- **status** (<a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSetStatus" >}}">ReplicaSetStatus</a>)
Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@ -52,7 +52,7 @@ ReplicaSetSpec is the specification of a ReplicaSet.
Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
- **template** (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec</a>)
- **template** (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec</a>)
Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
@ -146,7 +146,7 @@ ReplicaSetList is a collection of ReplicaSets.
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>), required
- **items** ([]<a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>), required
List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
@ -193,7 +193,7 @@ GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): OK
401: Unauthorized
@ -226,7 +226,7 @@ GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): OK
401: Unauthorized
@ -299,7 +299,7 @@ GET /apis/apps/v1/namespaces/{namespace}/replicasets
#### Response
200 (<a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSetList" >}}">ReplicaSetList</a>): OK
200 (<a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSetList" >}}">ReplicaSetList</a>): OK
401: Unauthorized
@ -367,7 +367,7 @@ GET /apis/apps/v1/replicasets
#### Response
200 (<a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSetList" >}}">ReplicaSetList</a>): OK
200 (<a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSetList" >}}">ReplicaSetList</a>): OK
401: Unauthorized
@ -386,7 +386,7 @@ POST /apis/apps/v1/namespaces/{namespace}/replicasets
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>, required
- **body**: <a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>, required
@ -410,11 +410,11 @@ POST /apis/apps/v1/namespaces/{namespace}/replicasets
#### Response
200 (<a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): OK
201 (<a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): Created
201 (<a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): Created
202 (<a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): Accepted
202 (<a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): Accepted
401: Unauthorized
@ -438,7 +438,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>, required
- **body**: <a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>, required
@ -462,9 +462,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): OK
201 (<a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): Created
201 (<a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): Created
401: Unauthorized
@ -488,7 +488,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>, required
- **body**: <a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>, required
@ -512,9 +512,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): OK
201 (<a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): Created
201 (<a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): Created
401: Unauthorized
@ -567,7 +567,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): OK
401: Unauthorized
@ -620,7 +620,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/replica-set-v1#ReplicaSet" >}}">ReplicaSet</a>): OK
401: Unauthorized

42
content/en/docs/reference/kubernetes-api/workload-resources/replication-controller-v1.md → content/en/docs/reference/kubernetes-api/workloads-resources/replication-controller-v1.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "ReplicationController represents the configuration of a replication controller."
title: "ReplicationController"
weight: 4
weight: 5
---
`apiVersion: v1`
@ -30,11 +30,11 @@ ReplicationController represents the configuration of a replication controller.
If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **spec** (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationControllerSpec" >}}">ReplicationControllerSpec</a>)
- **spec** (<a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationControllerSpec" >}}">ReplicationControllerSpec</a>)
Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- **status** (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationControllerStatus" >}}">ReplicationControllerStatus</a>)
- **status** (<a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationControllerStatus" >}}">ReplicationControllerStatus</a>)
Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@ -52,7 +52,7 @@ ReplicationControllerSpec is the specification of a replication controller.
Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
- **template** (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec</a>)
- **template** (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec</a>)
Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
@ -146,7 +146,7 @@ ReplicationControllerList is a collection of replication controllers.
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **items** ([]<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>), required
- **items** ([]<a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>), required
List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
@ -193,7 +193,7 @@ GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): OK
200 (<a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): OK
401: Unauthorized
@ -226,7 +226,7 @@ GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): OK
200 (<a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): OK
401: Unauthorized
@ -299,7 +299,7 @@ GET /api/v1/namespaces/{namespace}/replicationcontrollers
#### Response
200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationControllerList" >}}">ReplicationControllerList</a>): OK
200 (<a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationControllerList" >}}">ReplicationControllerList</a>): OK
401: Unauthorized
@ -367,7 +367,7 @@ GET /api/v1/replicationcontrollers
#### Response
200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationControllerList" >}}">ReplicationControllerList</a>): OK
200 (<a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationControllerList" >}}">ReplicationControllerList</a>): OK
401: Unauthorized
@ -386,7 +386,7 @@ POST /api/v1/namespaces/{namespace}/replicationcontrollers
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>, required
- **body**: <a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>, required
@ -410,11 +410,11 @@ POST /api/v1/namespaces/{namespace}/replicationcontrollers
#### Response
200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): OK
200 (<a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): OK
201 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): Created
201 (<a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): Created
202 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): Accepted
202 (<a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): Accepted
401: Unauthorized
@ -438,7 +438,7 @@ PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>, required
- **body**: <a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>, required
@ -462,9 +462,9 @@ PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): OK
200 (<a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): OK
201 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): Created
201 (<a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): Created
401: Unauthorized
@ -488,7 +488,7 @@ PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>, required
- **body**: <a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>, required
@ -512,9 +512,9 @@ PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): OK
200 (<a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): OK
201 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): Created
201 (<a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): Created
401: Unauthorized
@ -567,7 +567,7 @@ PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): OK
200 (<a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): OK
401: Unauthorized
@ -620,7 +620,7 @@ PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): OK
200 (<a href="{{< ref "../workloads-resources/replication-controller-v1#ReplicationController" >}}">ReplicationController</a>): OK
401: Unauthorized

46
content/en/docs/reference/kubernetes-api/workload-resources/stateful-set-v1.md → content/en/docs/reference/kubernetes-api/workloads-resources/stateful-set-v1.md
View File

@ -6,7 +6,7 @@ api_metadata:
content_type: "api_reference"
description: "StatefulSet represents a set of pods with consistent identities."
title: "StatefulSet"
weight: 7
weight: 8
---
`apiVersion: apps/v1`
@ -32,11 +32,11 @@ The StatefulSet guarantees that a given network identity will always map to the
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
- **spec** (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSetSpec" >}}">StatefulSetSpec</a>)
- **spec** (<a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSetSpec" >}}">StatefulSetSpec</a>)
Spec defines the desired identities of pods in this set.
- **status** (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSetStatus" >}}">StatefulSetStatus</a>)
- **status** (<a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSetStatus" >}}">StatefulSetStatus</a>)
Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
@ -58,7 +58,7 @@ A StatefulSetSpec is the specification of a StatefulSet.
selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
- **template** (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec</a>), required
- **template** (<a href="{{< ref "../workloads-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec</a>), required
template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
@ -84,9 +84,9 @@ A StatefulSetSpec is the specification of a StatefulSet.
<a name="RollingUpdateStatefulSetStrategy"></a>
*RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.*
- **updateStrategy.rollingUpdate.partition** (int32)
- **updateStrategy.rollingUpdate.partition** (int32)
Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0.
Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0.
- **podManagementPolicy** (string)
@ -193,7 +193,7 @@ StatefulSetList is a collection of StatefulSets.
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
- **items** ([]<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>), required
- **items** ([]<a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>), required
@ -239,7 +239,7 @@ GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): OK
401: Unauthorized
@ -272,7 +272,7 @@ GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): OK
401: Unauthorized
@ -345,7 +345,7 @@ GET /apis/apps/v1/namespaces/{namespace}/statefulsets
#### Response
200 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSetList" >}}">StatefulSetList</a>): OK
200 (<a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSetList" >}}">StatefulSetList</a>): OK
401: Unauthorized
@ -413,7 +413,7 @@ GET /apis/apps/v1/statefulsets
#### Response
200 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSetList" >}}">StatefulSetList</a>): OK
200 (<a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSetList" >}}">StatefulSetList</a>): OK
401: Unauthorized
@ -432,7 +432,7 @@ POST /apis/apps/v1/namespaces/{namespace}/statefulsets
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>, required
- **body**: <a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>, required
@ -456,11 +456,11 @@ POST /apis/apps/v1/namespaces/{namespace}/statefulsets
#### Response
200 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): OK
201 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): Created
201 (<a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): Created
202 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): Accepted
202 (<a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): Accepted
401: Unauthorized
@ -484,7 +484,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>, required
- **body**: <a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>, required
@ -508,9 +508,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): OK
201 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): Created
201 (<a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): Created
401: Unauthorized
@ -534,7 +534,7 @@ PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>, required
- **body**: <a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>, required
@ -558,9 +558,9 @@ PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): OK
201 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): Created
201 (<a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): Created
401: Unauthorized
@ -613,7 +613,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): OK
401: Unauthorized
@ -666,7 +666,7 @@ PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
#### Response
200 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): OK
200 (<a href="{{< ref "../workloads-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): OK
401: Unauthorized