API Ref multi-pages v1.27

pull/40458/head
Philippe Martin 2023-04-03 08:22:54 +02:00
parent 94b30e7c24
commit 7b39e9a9ec
67 changed files with 8340 additions and 3094 deletions

File diff suppressed because it is too large Load Diff

View File

@ -99,6 +99,7 @@
- initContainerStatuses
- containerStatuses
- ephemeralContainerStatuses
- resize
- definition: io.k8s.api.core.v1.Container
field_categories:
@ -127,6 +128,7 @@
- name: Resources
fields:
- resources
- resizePolicy
- name: Lifecycle
fields:
- lifecycle
@ -219,6 +221,9 @@
fields:
- volumeMounts
- volumeDevices
- name: Resources
fields:
- resizePolicy
- name: Lifecycle
fields:
- terminationMessagePath

View File

@ -66,18 +66,18 @@ parts:
- name: PriorityClass
group: scheduling.k8s.io
version: v1
- name: PodScheduling
- name: PodSchedulingContext
group: resource.k8s.io
version: v1alpha1
version: v1alpha2
- name: ResourceClaim
group: resource.k8s.io
version: v1alpha1
version: v1alpha2
- name: ResourceClaimTemplate
group: resource.k8s.io
version: v1alpha1
version: v1alpha2
- name: ResourceClass
group: resource.k8s.io
version: v1alpha1
version: v1alpha2
- name: Service Resources
chapters:
- name: Service
@ -148,6 +148,12 @@ parts:
- name: CertificateSigningRequest
group: certificates.k8s.io
version: v1
- name: ClusterTrustBundle
group: certificates.k8s.io
version: v1alpha1
- name: SelfSubjectReview
group: authentication.k8s.io
version: v1beta1
- name: Authorization Resources
chapters:
- name: LocalSubjectAccessReview
@ -191,6 +197,9 @@ parts:
- name: PodDisruptionBudget
group: policy
version: v1
- name: IPAddress
group: networking.k8s.io
version: v1alpha1
- name: Extend Resources
chapters:
- name: CustomResourceDefinition

View File

@ -404,6 +404,11 @@ GET /apis/certificates.k8s.io/v1/certificatesigningrequests
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -899,6 +904,11 @@ DELETE /apis/certificates.k8s.io/v1/certificatesigningrequests
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -0,0 +1,506 @@
---
api_metadata:
apiVersion: "certificates.k8s.io/v1alpha1"
import: "k8s.io/api/certificates/v1alpha1"
kind: "ClusterTrustBundle"
content_type: "api_reference"
description: "ClusterTrustBundle is a cluster-scoped container for X."
title: "ClusterTrustBundle v1alpha1"
weight: 5
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
`apiVersion: certificates.k8s.io/v1alpha1`
`import "k8s.io/api/certificates/v1alpha1"`
## ClusterTrustBundle {#ClusterTrustBundle}
ClusterTrustBundle is a cluster-scoped container for X.509 trust anchors (root certificates).
ClusterTrustBundle objects are considered to be readable by any authenticated user in the cluster, because they can be mounted by pods using the `clusterTrustBundle` projection. All service accounts have read access to ClusterTrustBundles by default. Users who only have namespace-level access to a cluster can read ClusterTrustBundles by impersonating a serviceaccount that they have access to.
It can be optionally associated with a particular assigner, in which case it contains one valid set of trust anchors for that signer. Signers may have multiple associated ClusterTrustBundles; each is an independent set of trust anchors for that signer. Admission control is used to enforce that only users with permissions on the signer can create or modify the corresponding bundle.
<hr>
- **apiVersion**: certificates.k8s.io/v1alpha1
- **kind**: ClusterTrustBundle
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
metadata contains the object metadata.
- **spec** (<a href="{{< ref "../authentication-resources/cluster-trust-bundle-v1alpha1#ClusterTrustBundleSpec" >}}">ClusterTrustBundleSpec</a>), required
spec contains the signer (if any) and trust anchors.
## ClusterTrustBundleSpec {#ClusterTrustBundleSpec}
ClusterTrustBundleSpec contains the signer and trust anchors.
<hr>
- **trustBundle** (string), required
trustBundle contains the individual X.509 trust anchors for this bundle, as PEM bundle of PEM-wrapped, DER-formatted X.509 certificates.
The data must consist only of PEM certificate blocks that parse as valid X.509 certificates. Each certificate must include a basic constraints extension with the CA bit set. The API server will reject objects that contain duplicate certificates, or that use PEM block headers.
Users of ClusterTrustBundles, including Kubelet, are free to reorder and deduplicate certificate blocks in this file according to their own logic, as well as to drop PEM block headers and inter-block data.
- **signerName** (string)
signerName indicates the associated signer, if any.
In order to create or update a ClusterTrustBundle that sets signerName, you must have the following cluster-scoped permission: group=certificates.k8s.io resource=signers resourceName=\<the signer name> verb=attest.
If signerName is not empty, then the ClusterTrustBundle object must be named with the signer name as a prefix (translating slashes to colons). For example, for the signer name `example.com/foo`, valid ClusterTrustBundle object names include `example.com:foo:abc` and `example.com:foo:v1`.
If signerName is empty, then the ClusterTrustBundle object's name must not have such a prefix.
List/watch requests for ClusterTrustBundles can filter on this field using a `spec.signerName=NAME` field selector.
## ClusterTrustBundleList {#ClusterTrustBundleList}
ClusterTrustBundleList is a collection of ClusterTrustBundle objects
<hr>
- **apiVersion**: certificates.k8s.io/v1alpha1
- **kind**: ClusterTrustBundleList
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
metadata contains the list metadata.
- **items** ([]<a href="{{< ref "../authentication-resources/cluster-trust-bundle-v1alpha1#ClusterTrustBundle" >}}">ClusterTrustBundle</a>), required
items is a collection of ClusterTrustBundle objects
## Operations {#Operations}
<hr>
### `get` read the specified ClusterTrustBundle
#### HTTP Request
GET /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ClusterTrustBundle
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../authentication-resources/cluster-trust-bundle-v1alpha1#ClusterTrustBundle" >}}">ClusterTrustBundle</a>): OK
401: Unauthorized
### `list` list or watch objects of kind ClusterTrustBundle
#### HTTP Request
GET /apis/certificates.k8s.io/v1alpha1/clustertrustbundles
#### 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>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</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 "../authentication-resources/cluster-trust-bundle-v1alpha1#ClusterTrustBundleList" >}}">ClusterTrustBundleList</a>): OK
401: Unauthorized
### `create` create a ClusterTrustBundle
#### HTTP Request
POST /apis/certificates.k8s.io/v1alpha1/clustertrustbundles
#### Parameters
- **body**: <a href="{{< ref "../authentication-resources/cluster-trust-bundle-v1alpha1#ClusterTrustBundle" >}}">ClusterTrustBundle</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>
- **fieldValidation** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../authentication-resources/cluster-trust-bundle-v1alpha1#ClusterTrustBundle" >}}">ClusterTrustBundle</a>): OK
201 (<a href="{{< ref "../authentication-resources/cluster-trust-bundle-v1alpha1#ClusterTrustBundle" >}}">ClusterTrustBundle</a>): Created
202 (<a href="{{< ref "../authentication-resources/cluster-trust-bundle-v1alpha1#ClusterTrustBundle" >}}">ClusterTrustBundle</a>): Accepted
401: Unauthorized
### `update` replace the specified ClusterTrustBundle
#### HTTP Request
PUT /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ClusterTrustBundle
- **body**: <a href="{{< ref "../authentication-resources/cluster-trust-bundle-v1alpha1#ClusterTrustBundle" >}}">ClusterTrustBundle</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>
- **fieldValidation** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../authentication-resources/cluster-trust-bundle-v1alpha1#ClusterTrustBundle" >}}">ClusterTrustBundle</a>): OK
201 (<a href="{{< ref "../authentication-resources/cluster-trust-bundle-v1alpha1#ClusterTrustBundle" >}}">ClusterTrustBundle</a>): Created
401: Unauthorized
### `patch` partially update the specified ClusterTrustBundle
#### HTTP Request
PATCH /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ClusterTrustBundle
- **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>
- **fieldValidation** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</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 "../authentication-resources/cluster-trust-bundle-v1alpha1#ClusterTrustBundle" >}}">ClusterTrustBundle</a>): OK
201 (<a href="{{< ref "../authentication-resources/cluster-trust-bundle-v1alpha1#ClusterTrustBundle" >}}">ClusterTrustBundle</a>): Created
401: Unauthorized
### `delete` delete a ClusterTrustBundle
#### HTTP Request
DELETE /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name}
#### Parameters
- **name** (*in path*): string, required
name of the ClusterTrustBundle
- **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 ClusterTrustBundle
#### HTTP Request
DELETE /apis/certificates.k8s.io/v1alpha1/clustertrustbundles
#### Parameters
- **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>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</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

View File

@ -0,0 +1,142 @@
---
api_metadata:
apiVersion: "authentication.k8s.io/v1beta1"
import: "k8s.io/api/authentication/v1beta1"
kind: "SelfSubjectReview"
content_type: "api_reference"
description: "SelfSubjectReview contains the user information that the kube-apiserver has about the user making this request."
title: "SelfSubjectReview v1beta1"
weight: 6
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
`apiVersion: authentication.k8s.io/v1beta1`
`import "k8s.io/api/authentication/v1beta1"`
## SelfSubjectReview {#SelfSubjectReview}
SelfSubjectReview contains the user information that the kube-apiserver has about the user making this request. When using impersonation, users will receive the user info of the user being impersonated. If impersonation or request header authentication is used, any extra keys will have their case ignored and returned as lowercase.
<hr>
- **apiVersion**: authentication.k8s.io/v1beta1
- **kind**: SelfSubjectReview
- **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
- **status** (<a href="{{< ref "../authentication-resources/self-subject-review-v1beta1#SelfSubjectReviewStatus" >}}">SelfSubjectReviewStatus</a>)
Status is filled in by the server with the user attributes.
## SelfSubjectReviewStatus {#SelfSubjectReviewStatus}
SelfSubjectReviewStatus is filled by the kube-apiserver and sent back to a user.
<hr>
- **userInfo** (UserInfo)
User attributes of the user making this request.
<a name="UserInfo"></a>
*UserInfo holds the information about the user needed to implement the user.Info interface.*
- **userInfo.extra** (map[string][]string)
Any additional information provided by the authenticator.
- **userInfo.groups** ([]string)
The names of groups this user is a part of.
- **userInfo.uid** (string)
A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
- **userInfo.username** (string)
The name that uniquely identifies this user among all active users.
## Operations {#Operations}
<hr>
### `create` create a SelfSubjectReview
#### HTTP Request
POST /apis/authentication.k8s.io/v1beta1/selfsubjectreviews
#### Parameters
- **body**: <a href="{{< ref "../authentication-resources/self-subject-review-v1beta1#SelfSubjectReview" >}}">SelfSubjectReview</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>
- **fieldValidation** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../authentication-resources/self-subject-review-v1beta1#SelfSubjectReview" >}}">SelfSubjectReview</a>): OK
201 (<a href="{{< ref "../authentication-resources/self-subject-review-v1beta1#SelfSubjectReview" >}}">SelfSubjectReview</a>): Created
202 (<a href="{{< ref "../authentication-resources/self-subject-review-v1beta1#SelfSubjectReview" >}}">SelfSubjectReview</a>): Accepted
401: Unauthorized

View File

@ -182,6 +182,11 @@ GET /api/v1/namespaces/{namespace}/serviceaccounts
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -250,6 +255,11 @@ GET /api/v1/serviceaccounts
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -560,6 +570,11 @@ DELETE /api/v1/namespaces/{namespace}/serviceaccounts
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -200,6 +200,11 @@ GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -485,6 +490,11 @@ DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -196,6 +196,11 @@ GET /apis/rbac.authorization.k8s.io/v1/clusterroles
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -481,6 +486,11 @@ DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -210,6 +210,11 @@ GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -278,6 +283,11 @@ GET /apis/rbac.authorization.k8s.io/v1/rolebindings
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -588,6 +598,11 @@ DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -195,6 +195,11 @@ GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -263,6 +268,11 @@ GET /apis/rbac.authorization.k8s.io/v1/roles
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -573,6 +583,11 @@ DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -28,7 +28,7 @@ guide. You can file document formatting bugs against the
## SelfSubjectReview {#SelfSubjectReview}
SelfSubjectReview contains the user information that the kube-apiserver has about the user making this request. When using impersonation, users will receive the user info of the user being impersonated.
SelfSubjectReview contains the user information that the kube-apiserver has about the user making this request. When using impersonation, users will receive the user info of the user being impersonated. If impersonation or request header authentication is used, any extra keys will have their case ignored and returned as lowercase.
<hr>

View File

@ -293,6 +293,11 @@ GET /apis/apiregistration.k8s.io/v1/apiservices
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -683,6 +688,11 @@ DELETE /apis/apiregistration.k8s.io/v1/apiservices
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -44,7 +44,7 @@ ClusterCIDR represents a single configuration for per-Node Pod CIDR allocations
- **spec** (<a href="{{< ref "../cluster-resources/cluster-cidr-v1alpha1#ClusterCIDRSpec" >}}">ClusterCIDRSpec</a>)
Spec is the desired state of the ClusterCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
spec is the desired state of the ClusterCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@ -58,19 +58,19 @@ ClusterCIDRSpec defines the desired state of ClusterCIDR.
- **perNodeHostBits** (int32), required
PerNodeHostBits defines the number of host bits to be configured per node. A subnet mask determines how much of the address is used for network bits and host bits. For example an IPv4 address of 192.168.0.0/24, splits the address into 24 bits for the network portion and 8 bits for the host portion. To allocate 256 IPs, set this field to 8 (a /24 mask for IPv4 or a /120 for IPv6). Minimum value is 4 (16 IPs). This field is immutable.
perNodeHostBits defines the number of host bits to be configured per node. A subnet mask determines how much of the address is used for network bits and host bits. For example an IPv4 address of 192.168.0.0/24, splits the address into 24 bits for the network portion and 8 bits for the host portion. To allocate 256 IPs, set this field to 8 (a /24 mask for IPv4 or a /120 for IPv6). Minimum value is 4 (16 IPs). This field is immutable.
- **ipv4** (string)
IPv4 defines an IPv4 IP block in CIDR notation(e.g. "10.0.0.0/8"). At least one of IPv4 and IPv6 must be specified. This field is immutable.
ipv4 defines an IPv4 IP block in CIDR notation(e.g. "10.0.0.0/8"). At least one of ipv4 and ipv6 must be specified. This field is immutable.
- **ipv6** (string)
IPv6 defines an IPv6 IP block in CIDR notation(e.g. "2001:db8::/64"). At least one of IPv4 and IPv6 must be specified. This field is immutable.
ipv6 defines an IPv6 IP block in CIDR notation(e.g. "2001:db8::/64"). At least one of ipv4 and ipv6 must be specified. This field is immutable.
- **nodeSelector** (NodeSelector)
NodeSelector defines which nodes the config is applicable to. An empty or nil NodeSelector selects all nodes. This field is immutable.
nodeSelector defines which nodes the config is applicable to. An empty or nil nodeSelector selects all nodes. This field is immutable.
<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.*
@ -112,7 +112,7 @@ ClusterCIDRList contains a list of ClusterCIDR.
- **items** ([]<a href="{{< ref "../cluster-resources/cluster-cidr-v1alpha1#ClusterCIDR" >}}">ClusterCIDR</a>), required
Items is the list of ClusterCIDRs.
items is the list of ClusterCIDRs.
@ -206,6 +206,11 @@ GET /apis/networking.k8s.io/v1alpha1/clustercidrs
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -491,6 +496,11 @@ DELETE /apis/networking.k8s.io/v1alpha1/clustercidrs
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -183,6 +183,11 @@ GET /api/v1/componentstatuses
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -258,6 +258,11 @@ GET /apis/events.k8s.io/v1/namespaces/{namespace}/events
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -326,6 +331,11 @@ GET /apis/events.k8s.io/v1/events
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -636,6 +646,11 @@ DELETE /apis/events.k8s.io/v1/namespaces/{namespace}/events
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -397,6 +397,11 @@ GET /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -787,6 +792,11 @@ DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta3/flowschemas
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -44,7 +44,7 @@ Lease defines a lease concept.
- **spec** (<a href="{{< ref "../cluster-resources/lease-v1#LeaseSpec" >}}">LeaseSpec</a>)
Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@ -69,7 +69,7 @@ LeaseSpec is a specification of a Lease.
- **leaseDurationSeconds** (int32)
leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime.
leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed renewTime.
- **leaseTransitions** (int32)
@ -104,7 +104,7 @@ LeaseList is a list of Lease objects.
- **items** ([]<a href="{{< ref "../cluster-resources/lease-v1#Lease" >}}">Lease</a>), required
Items is a list of schema objects.
items is a list of schema objects.
@ -208,6 +208,11 @@ GET /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -276,6 +281,11 @@ GET /apis/coordination.k8s.io/v1/leases
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -586,6 +596,11 @@ DELETE /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -106,8 +106,6 @@ NamespaceStatus is information about the current status of a Namespace.
- **phase** (string)
Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
@ -253,6 +251,11 @@ GET /api/v1/namespaces
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -120,8 +120,6 @@ NodeSpec describes the attributes that a node is created with.
- **taints.effect** (string), required
Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
- **taints.key** (string), required
@ -156,7 +154,7 @@ NodeStatus is information about the current status of a node.
*Patch strategy: merge on key `type`*
List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See https://pr.k8s.io/79391 for an example.
List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See https://pr.k8s.io/79391 for an example. Consumers should assume that addresses can change during the lifetime of a Node. However, there are some exceptions where this may not be possible, such as Pods that inherit a Node's address in its own status or consumers of the downward API (status.hostIP).
<a name="NodeAddress"></a>
*NodeAddress contains information for the node's address.*
@ -412,8 +410,6 @@ NodeStatus is information about the current status of a node.
- **phase** (string)
NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated.
- **volumesAttached** ([]AttachedVolume)
@ -578,6 +574,11 @@ GET /api/v1/nodes
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -968,6 +969,11 @@ DELETE /api/v1/nodes
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -313,6 +313,11 @@ GET /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -703,6 +708,11 @@ DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta3/prioritylevelconfigurations
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -44,11 +44,11 @@ RuntimeClass defines a class of container runtime supported in the cluster. The
- **handler** (string), required
Handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable.
handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable.
- **overhead** (Overhead)
Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see
overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see
https://kubernetes.io/docs/concepts/scheduling-eviction/pod-overhead/
<a name="Overhead"></a>
@ -56,11 +56,11 @@ RuntimeClass defines a class of container runtime supported in the cluster. The
- **overhead.podFixed** (map[string]<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
PodFixed represents the fixed resource overhead associated with running a pod.
podFixed represents the fixed resource overhead associated with running a pod.
- **scheduling** (Scheduling)
Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes.
scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes.
<a name="Scheduling"></a>
*Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass.*
@ -85,8 +85,6 @@ RuntimeClass defines a class of container runtime supported in the cluster. The
- **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.
- **scheduling.tolerations.value** (string)
@ -95,8 +93,6 @@ RuntimeClass defines a class of container runtime supported in the cluster. The
- **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.
- **scheduling.tolerations.tolerationSeconds** (int64)
@ -124,7 +120,7 @@ RuntimeClassList is a list of RuntimeClass objects.
- **items** ([]<a href="{{< ref "../cluster-resources/runtime-class-v1#RuntimeClass" >}}">RuntimeClass</a>), required
Items is a list of schema objects.
items is a list of schema objects.
@ -218,6 +214,11 @@ GET /apis/node.k8s.io/v1/runtimeclasses
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -503,6 +504,11 @@ DELETE /apis/node.k8s.io/v1/runtimeclasses
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -36,9 +36,7 @@ A node selector requirement is a selector that contains values, a key, and an op
- **operator** (string), required
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist, Gt, and Lt.
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
- **values** ([]string)

View File

@ -32,7 +32,7 @@ ObjectMeta is metadata that all persisted resources must have, which includes al
- **name** (string)
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
- **generateName** (string)
@ -46,15 +46,15 @@ ObjectMeta is metadata that all persisted resources must have, which includes al
Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
- **labels** (map[string]string)
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
- **annotations** (map[string]string)
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
@ -129,11 +129,11 @@ ObjectMeta is metadata that all persisted resources must have, which includes al
- **ownerReferences.name** (string), required
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
- **ownerReferences.uid** (string), required
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
- **ownerReferences.blockOwnerDeletion** (boolean)
@ -186,7 +186,7 @@ ObjectMeta is metadata that all persisted resources must have, which includes al
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

View File

@ -86,7 +86,7 @@ Status is a return value for calls that don't return other objects.
- **details.uid** (string)
UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids
UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
- **kind** (string)

View File

@ -80,7 +80,7 @@ A selector to restrict the list of returned objects by their fields. Defaults to
## fieldValidation {#fieldValidation}
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields, provided that the `ServerSideFieldValidation` feature gate is also enabled. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23 and is the default behavior when the `ServerSideFieldValidation` feature gate is disabled. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default when the `ServerSideFieldValidation` feature gate is enabled. - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
<hr>
@ -184,6 +184,28 @@ Defaults to unset
## sendInitialEvents {#sendInitialEvents}
`sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic "Bookmark" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `"k8s.io/initial-events-end": "true"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.
When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan
is interpreted as "data at least as new as the provided `resourceVersion`"
and the bookmark event is send when the state is synced
to a `resourceVersion` at least as fresh as the one provided by the ListOptions.
If `resourceVersion` is unset, this is interpreted as "consistent read" and the
bookmark event is send when the state is synced at least to the moment
when request started being processed.
- `resourceVersionMatch` set to any other value or unset
Invalid error is returned.
Defaults to true if `resourceVersion=""` or `resourceVersion="0"` (for backward compatibility reasons) and to false otherwise.
<hr>
## timeoutSeconds {#timeoutSeconds}
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

View File

@ -180,6 +180,11 @@ GET /api/v1/namespaces/{namespace}/configmaps
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -248,6 +253,11 @@ GET /api/v1/configmaps
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -558,6 +568,11 @@ DELETE /api/v1/namespaces/{namespace}/configmaps
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -44,7 +44,7 @@ CSIDriver captures information about a Container Storage Interface (CSI) volume
- **spec** (<a href="{{< ref "../config-and-storage-resources/csi-driver-v1#CSIDriverSpec" >}}">CSIDriverSpec</a>), required
Specification of the CSI Driver.
spec represents the specification of the CSI Driver.
@ -64,7 +64,7 @@ CSIDriverSpec is the specification of a CSIDriver.
- **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.
fsGroupPolicy 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 immutable.
@ -72,7 +72,11 @@ CSIDriverSpec is the specification of a CSIDriver.
- **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
podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations, if set to true. 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
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.
@ -81,13 +85,13 @@ CSIDriverSpec is the specification of a CSIDriver.
- **requiresRepublish** (boolean)
RequiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false.
requiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false.
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.
- **seLinuxMount** (boolean)
SELinuxMount specifies if the CSI driver supports "-o context" mount option.
seLinuxMount specifies if the CSI driver supports "-o context" mount option.
When "true", the CSI driver must ensure that all volumes provided by this CSI driver can be mounted separately with different `-o context` options. This is typical for storage backends that provide volumes as filesystems on block devices or as independent shared volumes. Kubernetes will call NodeStage / NodePublish with "-o context=xyz" mount option when mounting a ReadWriteOncePod volume used in Pod that has explicitly set SELinux context. In the future, it may be expanded to other volume AccessModes. In any case, Kubernetes will ensure that the volume is mounted only with a single SELinux context.
@ -97,7 +101,7 @@ CSIDriverSpec is the specification of a CSIDriver.
- **storageCapacity** (boolean)
If set to true, storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information.
storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information, if set to true.
The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object.
@ -109,7 +113,7 @@ CSIDriverSpec is the specification of a CSIDriver.
*Atomic: will be replaced during a merge*
TokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": {
tokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": {
"\<audience>": {
"token": \<token>,
"expirationTimestamp": \<expiration timestamp in RFC3339>,
@ -124,19 +128,23 @@ CSIDriverSpec is the specification of a CSIDriver.
- **tokenRequests.audience** (string), required
Audience is the intended audience of the token in "TokenRequestSpec". It will default to the audiences of kube apiserver.
audience is the intended audience of the token in "TokenRequestSpec". It will default to the audiences of kube apiserver.
- **tokenRequests.expirationSeconds** (int64)
ExpirationSeconds is the duration of validity of the token in "TokenRequestSpec". It has the same default value of "ExpirationSeconds" in "TokenRequestSpec".
expirationSeconds is the duration of validity of the token in "TokenRequestSpec". It has the same default value of "ExpirationSeconds" in "TokenRequestSpec".
- **volumeLifecycleModes** ([]string)
*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.
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.
This field is immutable.
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.
@ -254,6 +262,11 @@ GET /apis/storage.k8s.io/v1/csidrivers
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -539,6 +552,11 @@ DELETE /apis/storage.k8s.io/v1/csidrivers
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -40,7 +40,7 @@ CSINode holds information about all CSI drivers installed on a node. CSI drivers
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
metadata.name must be the Kubernetes node name.
Standard object's metadata. metadata.name must be the Kubernetes node name.
- **spec** (<a href="{{< ref "../config-and-storage-resources/csi-node-v1#CSINodeSpec" >}}">CSINodeSpec</a>), required
@ -67,7 +67,7 @@ CSINodeSpec holds information about the specification of all CSI drivers install
- **drivers.name** (string), required
This is the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver.
name represents the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver.
- **drivers.nodeID** (string), required
@ -82,7 +82,7 @@ CSINodeSpec holds information about the specification of all CSI drivers install
- **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.
count indicates the 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)
@ -204,6 +204,11 @@ GET /apis/storage.k8s.io/v1/csinodes
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -489,6 +494,11 @@ DELETE /apis/storage.k8s.io/v1/csinodes
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -48,7 +48,7 @@ They are consumed by the kube-scheduler when a CSI driver opts into capacity-awa
- **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.
Standard object's metadata. The name has no particular meaning. It must 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.
@ -56,23 +56,23 @@ They are consumed by the kube-scheduler when a CSI driver opts into capacity-awa
- **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.
storageClassName represents 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.
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.
- **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.
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.
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.
@ -98,7 +98,7 @@ CSIStorageCapacityList is a collection of CSIStorageCapacity objects.
*Map: unique values on key name will be kept during a merge*
Items is the list of CSIStorageCapacity objects.
items is the list of CSIStorageCapacity objects.
@ -202,6 +202,11 @@ GET /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -270,6 +275,11 @@ GET /apis/storage.k8s.io/v1/csistoragecapacities
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -580,6 +590,11 @@ DELETE /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -77,13 +77,13 @@ PersistentVolumeClaimSpec describes the common attributes of storage devices and
- **resources.claims** ([]ResourceClaim)
*Set: unique values will be kept during a merge*
*Map: unique values on key name will be kept during a merge*
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable.
This field is immutable. It can only be set for containers.
<a name="ResourceClaim"></a>
*ResourceClaim references one entry in PodSpec.ResourceClaims.*
@ -98,7 +98,7 @@ PersistentVolumeClaimSpec describes the common attributes of storage devices and
- **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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- **volumeName** (string)
@ -178,7 +178,7 @@ PersistentVolumeClaimStatus is the current status of a persistent volume claim.
conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
<a name="PersistentVolumeClaimCondition"></a>
*PersistentVolumeClaimCondition contails details about state of pvc*
*PersistentVolumeClaimCondition contains details about state of pvc*
- **conditions.status** (string), required
@ -211,8 +211,6 @@ PersistentVolumeClaimStatus is the current status of a persistent volume claim.
- **phase** (string)
phase represents the current phase of PersistentVolumeClaim.
- **resizeStatus** (string)
@ -377,6 +375,11 @@ GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -445,6 +448,11 @@ GET /api/v1/persistentvolumeclaims
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -870,6 +878,11 @@ DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -108,8 +108,6 @@ PersistentVolumeSpec is the specification of a persistent volume.
- **persistentVolumeReclaimPolicy** (string)
persistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
- **storageClassName** (string)
@ -329,7 +327,7 @@ PersistentVolumeSpec is the specification of a persistent volume.
- **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 beta 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.
controllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. 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*
@ -363,7 +361,7 @@ PersistentVolumeSpec is the specification of a persistent volume.
- **csi.nodeExpandSecretRef** (SecretReference)
nodeExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeExpandVolume call. This is an alpha field and requires enabling CSINodeExpandSecret feature gate. This field is optional, may be omitted if no secret is required. If the secret object contains more than one secret, all secrets are passed.
nodeExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeExpandVolume call. This is a beta field which is enabled default by CSINodeExpandSecret feature gate. This field is optional, may be omitted 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*
@ -519,6 +517,29 @@ PersistentVolumeSpec is the specification of a persistent volume.
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- **glusterfs** (GlusterfsPersistentVolumeSource)
glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md
<a name="GlusterfsPersistentVolumeSource"></a>
*Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.*
- **glusterfs.endpoints** (string), required
endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- **glusterfs.path** (string), required
path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- **glusterfs.endpointsNamespace** (string)
endpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- **glusterfs.readOnly** (boolean)
readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- **iscsi** (ISCSIPersistentVolumeSource)
iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.
@ -838,8 +859,6 @@ PersistentVolumeStatus is the current status of a persistent volume.
- **phase** (string)
phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase
- **reason** (string)
@ -989,6 +1008,11 @@ GET /api/v1/persistentvolumes
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -1379,6 +1403,11 @@ DELETE /api/v1/persistentvolumes
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -184,6 +184,11 @@ GET /api/v1/namespaces/{namespace}/secrets
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -252,6 +257,11 @@ GET /api/v1/secrets
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -562,6 +572,11 @@ DELETE /api/v1/namespaces/{namespace}/secrets
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -46,17 +46,17 @@ StorageClasses are non-namespaced; the name of the storage class according to et
- **provisioner** (string), required
Provisioner indicates the type of the provisioner.
provisioner indicates the type of the provisioner.
- **allowVolumeExpansion** (boolean)
AllowVolumeExpansion shows whether the storage class allow volume expand
allowVolumeExpansion shows whether the storage class allow volume expand.
- **allowedTopologies** ([]TopologySelectorTerm)
*Atomic: will be replaced during a merge*
Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.
allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.
<a name="TopologySelectorTerm"></a>
*A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.*
@ -78,19 +78,19 @@ StorageClasses are non-namespaced; the name of the storage class according to et
- **mountOptions** ([]string)
Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.
- **parameters** (map[string]string)
Parameters holds the parameters for the provisioner that should create volumes of this storage class.
parameters holds the parameters for the provisioner that should create volumes of this storage class.
- **reclaimPolicy** (string)
Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.
reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete.
- **volumeBindingMode** (string)
VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.
volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.
@ -114,7 +114,7 @@ StorageClassList is a collection of storage classes.
- **items** ([]<a href="{{< ref "../config-and-storage-resources/storage-class-v1#StorageClass" >}}">StorageClass</a>), required
Items is the list of StorageClasses
items is the list of StorageClasses
@ -208,6 +208,11 @@ GET /apis/storage.k8s.io/v1/storageclasses
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -493,6 +498,11 @@ DELETE /apis/storage.k8s.io/v1/storageclasses
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -46,11 +46,11 @@ VolumeAttachment objects are non-namespaced.
- **spec** (<a href="{{< ref "../config-and-storage-resources/volume-attachment-v1#VolumeAttachmentSpec" >}}">VolumeAttachmentSpec</a>), required
Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
spec represents specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
- **status** (<a href="{{< ref "../config-and-storage-resources/volume-attachment-v1#VolumeAttachmentStatus" >}}">VolumeAttachmentStatus</a>)
Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.
status represents status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.
@ -64,15 +64,15 @@ VolumeAttachmentSpec is the specification of a VolumeAttachment request.
- **attacher** (string), required
Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
- **nodeName** (string), required
The node that the volume should be attached to.
nodeName represents the node that the volume should be attached to.
- **source** (VolumeAttachmentSource), required
Source represents the volume that should be attached.
source represents the volume that should be attached.
<a name="VolumeAttachmentSource"></a>
*VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.*
@ -83,7 +83,7 @@ VolumeAttachmentSpec is the specification of a VolumeAttachment request.
- **source.persistentVolumeName** (string)
Name of the persistent volume to attach.
persistentVolumeName represents the name of the persistent volume to attach.
@ -97,44 +97,44 @@ VolumeAttachmentStatus is the status of a VolumeAttachment request.
- **attached** (boolean), required
Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
attached indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
- **attachError** (VolumeError)
The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
attachError represents the last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
<a name="VolumeError"></a>
*VolumeError captures an error encountered during a volume operation.*
- **attachError.message** (string)
String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.
message represents the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.
- **attachError.time** (Time)
Time the error was encountered.
time represents the time the error was encountered.
<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.*
- **attachmentMetadata** (map[string]string)
Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
attachmentMetadata is populated with any information returned by the attach operation, upon successful attach, that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
- **detachError** (VolumeError)
The last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher.
detachError represents the last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher.
<a name="VolumeError"></a>
*VolumeError captures an error encountered during a volume operation.*
- **detachError.message** (string)
String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.
message represents the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.
- **detachError.time** (Time)
Time the error was encountered.
time represents the time the error was encountered.
<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.*
@ -161,7 +161,7 @@ VolumeAttachmentList is a collection of VolumeAttachment objects.
- **items** ([]<a href="{{< ref "../config-and-storage-resources/volume-attachment-v1#VolumeAttachment" >}}">VolumeAttachment</a>), required
Items is the list of VolumeAttachments
items is the list of VolumeAttachments
@ -283,6 +283,11 @@ GET /apis/storage.k8s.io/v1/volumeattachments
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -673,6 +678,11 @@ DELETE /apis/storage.k8s.io/v1/volumeattachments
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -230,7 +230,7 @@ Volume represents a named volume in a pod that may be accessed by any container
- **emptyDir.sizeLimit** (<a href="{{< ref "../common-definitions/quantity#Quantity" >}}">Quantity</a>)
sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir
sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- **hostPath** (HostPathVolumeSource)
@ -541,6 +541,25 @@ Volume represents a named volume in a pod that may be accessed by any container
readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- **glusterfs** (GlusterfsVolumeSource)
glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md
<a name="GlusterfsVolumeSource"></a>
*Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.*
- **glusterfs.endpoints** (string), required
endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- **glusterfs.path** (string), required
path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- **glusterfs.readOnly** (boolean)
readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- **iscsi** (ISCSIVolumeSource)
iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

View File

@ -210,12 +210,12 @@ CustomResourceDefinitionSpec describes how a user wants their resource to appear
- **conversion.strategy** (string), required
strategy specifies how custom resources are converted between versions. Allowed values are: - `None`: The converter only change the apiVersion and would not touch any other field in the custom resource. - `Webhook`: API Server will call to an external webhook to do the conversion. Additional information
strategy specifies how custom resources are converted between versions. Allowed values are: - `"None"`: The converter only change the apiVersion and would not touch any other field in the custom resource. - `"Webhook"`: API Server will call to an external webhook to do the conversion. Additional information
is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhook to be set.
- **conversion.webhook** (WebhookConversion)
webhook describes how to call the conversion webhook. Required when `strategy` is set to `Webhook`.
webhook describes how to call the conversion webhook. Required when `strategy` is set to `"Webhook"`.
<a name="WebhookConversion"></a>
*WebhookConversion describes how to call a conversion webhook*
@ -533,6 +533,10 @@ JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-sc
Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host"
- **x-kubernetes-validations.messageExpression** (string)
MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the rule; the only difference is the return type. Example: "x must be less than max ("+string(self.max)+")"
@ -756,6 +760,11 @@ GET /apis/apiextensions.k8s.io/v1/customresourcedefinitions
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -1146,6 +1155,11 @@ DELETE /apis/apiextensions.k8s.io/v1/customresourcedefinitions
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -117,6 +117,44 @@ MutatingWebhookConfiguration describes the configuration of and admission webhoo
FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.
- **webhooks.matchConditions** ([]MatchCondition)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
MatchConditions is a list of conditions that must be met for a request to be sent to this webhook. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed.
The exact matching logic is (in order):
1. If ANY matchCondition evaluates to FALSE, the webhook is skipped.
2. If ALL matchConditions evaluate to TRUE, the webhook is called.
3. If any matchCondition evaluates to an error (but none are FALSE):
- If failurePolicy=Fail, reject the request
- If failurePolicy=Ignore, the error is ignored and the webhook is skipped
This is an alpha feature and managed by the AdmissionWebhookMatchConditions feature gate.
<a name="MatchCondition"></a>
*MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook.*
- **webhooks.matchConditions.expression** (string), required
Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables:
'object' - The object from the incoming request. The value is null for DELETE requests. 'oldObject' - The existing object. The value is null for CREATE requests. 'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.
See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the
request resource.
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/
Required.
- **webhooks.matchConditions.name** (string), required
Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the associated expression. Name must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName')
Required.
- **webhooks.matchPolicy** (string)
matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent".
@ -336,6 +374,11 @@ GET /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -621,6 +664,11 @@ DELETE /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -49,50 +49,82 @@ ValidatingAdmissionPolicy describes the definition of an admission validation po
<a name="ValidatingAdmissionPolicySpec"></a>
*ValidatingAdmissionPolicySpec is the specification of the desired behavior of the AdmissionPolicy.*
- **spec.validations** ([]Validation), required
- **spec.auditAnnotations** ([]AuditAnnotation)
*Atomic: will be replaced during a merge*
Validations contain CEL expressions which is used to apply the validation. A minimum of one validation is required for a policy definition. Required.
auditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request. validations and auditAnnotations may not both be empty; a least one of validations or auditAnnotations is required.
<a name="Validation"></a>
*Validation specifies the CEL expression which is used to apply the validation.*
<a name="AuditAnnotation"></a>
*AuditAnnotation describes how to produce an audit annotation for an API request.*
- **spec.validations.expression** (string), required
- **spec.auditAnnotations.key** (string), required
Expression represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec CEL expressions have access to the contents of the Admission request/response, organized into CEL variables as well as some other useful variables:
key specifies the audit annotation key. The audit annotation keys of a ValidatingAdmissionPolicy must be unique. The key must be a qualified name ([A-Za-z0-9][-A-Za-z0-9_.]*) no more than 63 bytes in length.
'object' - The object from the incoming request. The value is null for DELETE requests. 'oldObject' - The existing object. The value is null for CREATE requests. 'request' - Attributes of the admission request([ref](/pkg/apis/admission/types.go#AdmissionRequest)). 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind.
The key is combined with the resource name of the ValidatingAdmissionPolicy to construct an audit annotation key: "{ValidatingAdmissionPolicy name}/{key}".
The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object. No other metadata properties are accessible.
If an admission webhook uses the same resource name as this ValidatingAdmissionPolicy and the same audit annotation key, the annotation key will be identical. In this case, the first annotation written with the key will be included in the audit event and all subsequent annotations with the same key will be discarded.
Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are:
"true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if",
"import", "let", "loop", "package", "namespace", "return".
Examples:
- Expression accessing a property named "namespace": {"Expression": "object.__namespace__ > 0"}
- Expression accessing a property named "x-prop": {"Expression": "object.x__dash__prop > 0"}
- Expression accessing a property named "redact__d": {"Expression": "object.redact__underscores__d > 0"}
Equality on arrays with list type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
- 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and
non-intersecting elements in `Y` are appended, retaining their partial order.
- 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values
are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with
non-intersecting keys are appended, retaining their partial order.
Required.
- **spec.validations.message** (string)
- **spec.auditAnnotations.valueExpression** (string), required
Message represents the message displayed when validation fails. The message is required if the Expression contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host" If the Expression contains line breaks. Message is required. The message must not contain line breaks. If unset, the message is "failed Expression: {Expression}".
- **spec.validations.reason** (string)
Reason represents a machine-readable description of why this validation failed. If this is the first validation in the list to fail, this reason, as well as the corresponding HTTP response code, are used in the HTTP response to the client. The currently supported reasons are: "Unauthorized", "Forbidden", "Invalid", "RequestEntityTooLarge". If not set, StatusReasonInvalid is used in the response to the client.
valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value. The expression must evaluate to either a string or null value. If the expression evaluates to a string, the audit annotation is included with the string value. If the expression evaluates to null or empty string the audit annotation will be omitted. The valueExpression may be no longer than 5kb in length. If the result of the valueExpression is more than 10kb in length, it will be truncated to 10kb.
If multiple ValidatingAdmissionPolicyBinding resources match an API request, then the valueExpression will be evaluated for each binding. All unique values produced by the valueExpressions will be joined together in a comma-separated list.
Required.
- **spec.failurePolicy** (string)
FailurePolicy defines how to handle failures for the admission policy. Failures can occur from invalid or mis-configured policy definitions or bindings. A policy is invalid if spec.paramKind refers to a non-existent Kind. A binding is invalid if spec.paramRef.name refers to a non-existent resource. Allowed values are Ignore or Fail. Defaults to Fail.
failurePolicy defines how to handle failures for the admission policy. Failures can occur from CEL expression parse errors, type check errors, runtime errors and invalid or mis-configured policy definitions or bindings.
A policy is invalid if spec.paramKind refers to a non-existent Kind. A binding is invalid if spec.paramRef.name refers to a non-existent resource.
failurePolicy does not define how validations that evaluate to false are handled.
When failurePolicy is set to Fail, ValidatingAdmissionPolicyBinding validationActions define how failures are enforced.
Allowed values are Ignore or Fail. Defaults to Fail.
- **spec.matchConditions** ([]MatchCondition)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
MatchConditions is a list of conditions that must be met for a request to be validated. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed.
If a parameter object is provided, it can be accessed via the `params` handle in the same manner as validation expressions.
The exact matching logic is (in order):
1. If ANY matchCondition evaluates to FALSE, the policy is skipped.
2. If ALL matchConditions evaluate to TRUE, the policy is evaluated.
3. If any matchCondition evaluates to an error (but none are FALSE):
- If failurePolicy=Fail, reject the request
- If failurePolicy=Ignore, the policy is skipped
<a name="MatchCondition"></a>
**
- **spec.matchConditions.expression** (string), required
Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables:
'object' - The object from the incoming request. The value is null for DELETE requests. 'oldObject' - The existing object. The value is null for CREATE requests. 'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.
See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the
request resource.
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/
Required.
- **spec.matchConditions.name** (string), required
Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the associated expression. Name must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName')
Required.
- **spec.matchConstraints** (MatchResources)
@ -262,6 +294,125 @@ ValidatingAdmissionPolicy describes the definition of an admission validation po
Kind is the API kind the resources belong to. Required.
- **spec.validations** ([]Validation)
*Atomic: will be replaced during a merge*
Validations contain CEL expressions which is used to apply the validation. Validations and AuditAnnotations may not both be empty; a minimum of one Validations or AuditAnnotations is required.
<a name="Validation"></a>
*Validation specifies the CEL expression which is used to apply the validation.*
- **spec.validations.expression** (string), required
Expression represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec CEL expressions have access to the contents of the API request/response, organized into CEL variables as well as some other useful variables:
- 'object' - The object from the incoming request. The value is null for DELETE requests. - 'oldObject' - The existing object. The value is null for CREATE requests. - 'request' - Attributes of the API request([ref](/pkg/apis/admission/types.go#AdmissionRequest)). - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind. - 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.
See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
- 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the
request resource.
The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object. No other metadata properties are accessible.
Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are:
"true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if",
"import", "let", "loop", "package", "namespace", "return".
Examples:
- Expression accessing a property named "namespace": {"Expression": "object.__namespace__ > 0"}
- Expression accessing a property named "x-prop": {"Expression": "object.x__dash__prop > 0"}
- Expression accessing a property named "redact__d": {"Expression": "object.redact__underscores__d > 0"}
Equality on arrays with list type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
- 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and
non-intersecting elements in `Y` are appended, retaining their partial order.
- 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values
are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with
non-intersecting keys are appended, retaining their partial order.
Required.
- **spec.validations.message** (string)
Message represents the message displayed when validation fails. The message is required if the Expression contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host" If the Expression contains line breaks. Message is required. The message must not contain line breaks. If unset, the message is "failed Expression: {Expression}".
- **spec.validations.messageExpression** (string)
messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a validation, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the `expression` except for 'authorizer' and 'authorizer.requestResource'. Example: "object.x must be less than max ("+string(params.max)+")"
- **spec.validations.reason** (string)
Reason represents a machine-readable description of why this validation failed. If this is the first validation in the list to fail, this reason, as well as the corresponding HTTP response code, are used in the HTTP response to the client. The currently supported reasons are: "Unauthorized", "Forbidden", "Invalid", "RequestEntityTooLarge". If not set, StatusReasonInvalid is used in the response to the client.
- **status** (ValidatingAdmissionPolicyStatus)
The status of the ValidatingAdmissionPolicy, including warnings that are useful to determine if the policy behaves in the expected way. Populated by the system. Read-only.
<a name="ValidatingAdmissionPolicyStatus"></a>
*ValidatingAdmissionPolicyStatus represents the status of a ValidatingAdmissionPolicy.*
- **status.conditions** ([]Condition)
*Map: unique values on key type will be kept during a merge*
The conditions represent the latest available observations of a policy's current state.
<a name="Condition"></a>
*Condition contains details for one aspect of the current state of this API Resource.*
- **status.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.*
- **status.conditions.message** (string), required
message is a human readable message indicating details about the transition. This may be an empty string.
- **status.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.
- **status.conditions.status** (string), required
status of the condition, one of True, False, Unknown.
- **status.conditions.type** (string), required
type of condition in CamelCase or in foo.example.com/CamelCase.
- **status.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.
- **status.observedGeneration** (int64)
The generation observed by the controller.
- **status.typeChecking** (TypeChecking)
The results of type checking for each expression. Presence of this field indicates the completion of the type checking.
<a name="TypeChecking"></a>
*TypeChecking contains results of type checking the expressions in the ValidatingAdmissionPolicy*
- **status.typeChecking.expressionWarnings** ([]ExpressionWarning)
*Atomic: will be replaced during a merge*
The type checking warnings for each expression.
<a name="ExpressionWarning"></a>
*ExpressionWarning is a warning information that targets a specific expression.*
- **status.typeChecking.expressionWarnings.fieldRef** (string), required
The path to the field that refers the expression. For example, the reference to the expression of the first item of validations is "spec.validations[0].expression"
- **status.typeChecking.expressionWarnings.warning** (string), required
The content of type checking information in a human-readable form. Each line of the warning contains the type that the expression is checked against, followed by the type check error from the compiler.
@ -489,6 +640,30 @@ ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with parame
PolicyName references a ValidatingAdmissionPolicy name which the ValidatingAdmissionPolicyBinding binds to. If the referenced resource does not exist, this binding is considered invalid and will be ignored Required.
- **spec.validationActions** ([]string)
*Set: unique values will be kept during a merge*
validationActions declares how Validations of the referenced ValidatingAdmissionPolicy are enforced. If a validation evaluates to false it is always enforced according to these actions.
Failures defined by the ValidatingAdmissionPolicy's FailurePolicy are enforced according to these actions only if the FailurePolicy is set to Fail, otherwise the failures are ignored. This includes compilation errors, runtime errors and misconfigurations of the policy.
validationActions is declared as a set of action values. Order does not matter. validationActions may not contain duplicates of the same action.
The supported actions values are:
"Deny" specifies that a validation failure results in a denied request.
"Warn" specifies that a validation failure is reported to the request client in HTTP Warning headers, with a warning code of 299. Warnings can be sent both for allowed or denied admission responses.
"Audit" specifies that a validation failure is included in the published audit event for the request. The audit event will contain a `validation.policy.admission.k8s.io/validation_failure` audit annotation with a value containing the details of the validation failures, formatted as a JSON list of objects, each with the following fields: - message: The validation failure message string - policy: The resource name of the ValidatingAdmissionPolicy - binding: The resource name of the ValidatingAdmissionPolicyBinding - expressionIndex: The index of the failed validations in the ValidatingAdmissionPolicy - validationActions: The enforcement actions enacted for the validation failure Example audit annotation: `"validation.policy.admission.k8s.io/validation_failure": "[{"message": "Invalid value", {"policy": "policy.example.com", {"binding": "policybinding.example.com", {"expressionIndex": "1", {"validationActions": ["Audit"]}]"`
Clients should expect to handle additional values by ignoring any values not recognized.
"Deny" and "Warn" may not be used together since this combination needlessly duplicates the validation failure both in the API response body and the HTTP warning headers.
Required.
@ -524,6 +699,34 @@ GET /apis/admissionregistration.k8s.io/v1alpha1/validatingadmissionpolicies/{nam
#### Response
200 (<a href="{{< ref "../extend-resources/validating-admission-policy-v1alpha1#ValidatingAdmissionPolicy" >}}">ValidatingAdmissionPolicy</a>): OK
401: Unauthorized
### `get` read status of the specified ValidatingAdmissionPolicy
#### HTTP Request
GET /apis/admissionregistration.k8s.io/v1alpha1/validatingadmissionpolicies/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingAdmissionPolicy
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
@ -581,6 +784,11 @@ GET /apis/admissionregistration.k8s.io/v1alpha1/validatingadmissionpolicies
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -666,6 +874,56 @@ PUT /apis/admissionregistration.k8s.io/v1alpha1/validatingadmissionpolicies/{nam
- **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>
- **fieldValidation** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../extend-resources/validating-admission-policy-v1alpha1#ValidatingAdmissionPolicy" >}}">ValidatingAdmissionPolicy</a>): OK
201 (<a href="{{< ref "../extend-resources/validating-admission-policy-v1alpha1#ValidatingAdmissionPolicy" >}}">ValidatingAdmissionPolicy</a>): Created
401: Unauthorized
### `update` replace status of the specified ValidatingAdmissionPolicy
#### HTTP Request
PUT /apis/admissionregistration.k8s.io/v1alpha1/validatingadmissionpolicies/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingAdmissionPolicy
- **body**: <a href="{{< ref "../extend-resources/validating-admission-policy-v1alpha1#ValidatingAdmissionPolicy" >}}">ValidatingAdmissionPolicy</a>, required
- **dryRun** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
@ -716,6 +974,61 @@ PATCH /apis/admissionregistration.k8s.io/v1alpha1/validatingadmissionpolicies/{n
- **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>
- **fieldValidation** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</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 "../extend-resources/validating-admission-policy-v1alpha1#ValidatingAdmissionPolicy" >}}">ValidatingAdmissionPolicy</a>): OK
201 (<a href="{{< ref "../extend-resources/validating-admission-policy-v1alpha1#ValidatingAdmissionPolicy" >}}">ValidatingAdmissionPolicy</a>): Created
401: Unauthorized
### `patch` partially update status of the specified ValidatingAdmissionPolicy
#### HTTP Request
PATCH /apis/admissionregistration.k8s.io/v1alpha1/validatingadmissionpolicies/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the ValidatingAdmissionPolicy
- **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>
@ -866,6 +1179,11 @@ DELETE /apis/admissionregistration.k8s.io/v1alpha1/validatingadmissionpolicies
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -117,6 +117,44 @@ ValidatingWebhookConfiguration describes the configuration of and admission webh
FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.
- **webhooks.matchConditions** ([]MatchCondition)
*Patch strategy: merge on key `name`*
*Map: unique values on key name will be kept during a merge*
MatchConditions is a list of conditions that must be met for a request to be sent to this webhook. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed.
The exact matching logic is (in order):
1. If ANY matchCondition evaluates to FALSE, the webhook is skipped.
2. If ALL matchConditions evaluate to TRUE, the webhook is called.
3. If any matchCondition evaluates to an error (but none are FALSE):
- If failurePolicy=Fail, reject the request
- If failurePolicy=Ignore, the error is ignored and the webhook is skipped
This is an alpha feature and managed by the AdmissionWebhookMatchConditions feature gate.
<a name="MatchCondition"></a>
*MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook.*
- **webhooks.matchConditions.expression** (string), required
Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables:
'object' - The object from the incoming request. The value is null for DELETE requests. 'oldObject' - The existing object. The value is null for CREATE requests. 'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.
See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the
request resource.
Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/
Required.
- **webhooks.matchConditions.name** (string), required
Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the associated expression. Name must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName')
Required.
- **webhooks.matchPolicy** (string)
matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent".
@ -326,6 +364,11 @@ GET /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -611,6 +654,11 @@ DELETE /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -0,0 +1,509 @@
---
api_metadata:
apiVersion: "networking.k8s.io/v1alpha1"
import: "k8s.io/api/networking/v1alpha1"
kind: "IPAddress"
content_type: "api_reference"
description: "IPAddress represents a single IP of a single IP Family."
title: "IPAddress v1alpha1"
weight: 5
auto_generated: true
---
<!--
The file is auto-generated from the Go source code of the component using a generic
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
to generate the reference documentation, please read
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
To update the reference content, please follow the
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
`apiVersion: networking.k8s.io/v1alpha1`
`import "k8s.io/api/networking/v1alpha1"`
## IPAddress {#IPAddress}
IPAddress represents a single IP of a single IP Family. The object is designed to be used by APIs that operate on IP addresses. The object is used by the Service core API for allocation of IP addresses. An IP address can be represented in different formats, to guarantee the uniqueness of the IP, the name of the object is the IP address in canonical format, four decimal digits separated by dots suppressing leading zeros for IPv4 and the representation defined by RFC 5952 for IPv6. Valid: 192.168.1.5 or 2001:db8::1 or 2001:db8:aaaa:bbbb:cccc:dddd:eeee:1 Invalid: 10.01.2.3 or 2001:db8:0:0:0::1
<hr>
- **apiVersion**: networking.k8s.io/v1alpha1
- **kind**: IPAddress
- **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/ip-address-v1alpha1#IPAddressSpec" >}}">IPAddressSpec</a>)
spec is the desired state of the IPAddress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
## IPAddressSpec {#IPAddressSpec}
IPAddressSpec describe the attributes in an IP Address.
<hr>
- **parentRef** (ParentReference)
ParentRef references the resource that an IPAddress is attached to. An IPAddress must reference a parent object.
<a name="ParentReference"></a>
*ParentReference describes a reference to a parent object.*
- **parentRef.group** (string)
Group is the group of the object being referenced.
- **parentRef.name** (string)
Name is the name of the object being referenced.
- **parentRef.namespace** (string)
Namespace is the namespace of the object being referenced.
- **parentRef.resource** (string)
Resource is the resource of the object being referenced.
- **parentRef.uid** (string)
UID is the uid of the object being referenced.
## IPAddressList {#IPAddressList}
IPAddressList contains a list of IPAddress.
<hr>
- **apiVersion**: networking.k8s.io/v1alpha1
- **kind**: IPAddressList
- **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/ip-address-v1alpha1#IPAddress" >}}">IPAddress</a>), required
items is the list of IPAddresses.
## Operations {#Operations}
<hr>
### `get` read the specified IPAddress
#### HTTP Request
GET /apis/networking.k8s.io/v1alpha1/ipaddresses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the IPAddress
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress</a>): OK
401: Unauthorized
### `list` list or watch objects of kind IPAddress
#### HTTP Request
GET /apis/networking.k8s.io/v1alpha1/ipaddresses
#### 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>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</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 "../policy-resources/ip-address-v1alpha1#IPAddressList" >}}">IPAddressList</a>): OK
401: Unauthorized
### `create` create an IPAddress
#### HTTP Request
POST /apis/networking.k8s.io/v1alpha1/ipaddresses
#### Parameters
- **body**: <a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress</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>
- **fieldValidation** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress</a>): OK
201 (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress</a>): Created
202 (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress</a>): Accepted
401: Unauthorized
### `update` replace the specified IPAddress
#### HTTP Request
PUT /apis/networking.k8s.io/v1alpha1/ipaddresses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the IPAddress
- **body**: <a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress</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>
- **fieldValidation** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
- **pretty** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
#### Response
200 (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress</a>): OK
201 (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress</a>): Created
401: Unauthorized
### `patch` partially update the specified IPAddress
#### HTTP Request
PATCH /apis/networking.k8s.io/v1alpha1/ipaddresses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the IPAddress
- **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>
- **fieldValidation** (*in query*): string
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</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 "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress</a>): OK
201 (<a href="{{< ref "../policy-resources/ip-address-v1alpha1#IPAddress" >}}">IPAddress</a>): Created
401: Unauthorized
### `delete` delete an IPAddress
#### HTTP Request
DELETE /apis/networking.k8s.io/v1alpha1/ipaddresses/{name}
#### Parameters
- **name** (*in path*): string, required
name of the IPAddress
- **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 IPAddress
#### HTTP Request
DELETE /apis/networking.k8s.io/v1alpha1/ipaddresses
#### Parameters
- **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>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</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

View File

@ -213,6 +213,11 @@ GET /api/v1/namespaces/{namespace}/limitranges
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -281,6 +286,11 @@ GET /api/v1/limitranges
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -591,6 +601,11 @@ DELETE /api/v1/namespaces/{namespace}/limitranges
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -44,11 +44,11 @@ NetworkPolicy describes what network traffic is allowed for a set of Pods
- **spec** (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicySpec" >}}">NetworkPolicySpec</a>)
Specification of the desired behavior for this NetworkPolicy.
spec represents the specification of the desired behavior for this NetworkPolicy.
- **status** (<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicyStatus" >}}">NetworkPolicyStatus</a>)
Status is the current state of the NetworkPolicy. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
status represents the current state of the NetworkPolicy. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
@ -62,137 +62,137 @@ NetworkPolicySpec provides the specification of a NetworkPolicy
- **podSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>), required
Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
podSelector selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
- **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
policyTypes is a 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)
List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)
ingress is a list of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)
<a name="NetworkPolicyIngressRule"></a>
*NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.*
- **ingress.from** ([]NetworkPolicyPeer)
List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list.
from is a list of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list.
<a name="NetworkPolicyPeer"></a>
*NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed*
- **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.0/24","2001:db8::/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
CIDR is a string representing the IP Block Valid examples are "192.168.1.0/24" or "2001:db8::/64"
cidr is a string representing the IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64"
- **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.0/24" or "2001:db8::/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 IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/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>)
Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.
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.
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>)
This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods.
podSelector 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.
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)
List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
ports is a list of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
<a name="NetworkPolicyPort"></a>
*NetworkPolicyPort describes a port to allow traffic on*
- **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.
port represents 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.
<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)
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.
endPort indicates that the range of ports from port to endPort if set, 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.
- **ingress.ports.protocol** (string)
The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
- **egress** ([]NetworkPolicyEgressRule)
List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8
egress is a list of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8
<a name="NetworkPolicyEgressRule"></a>
*NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8*
- **egress.to** ([]NetworkPolicyPeer)
List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.
to is a list of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.
<a name="NetworkPolicyPeer"></a>
*NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed*
- **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.0/24","2001:db8::/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
CIDR is a string representing the IP Block Valid examples are "192.168.1.0/24" or "2001:db8::/64"
cidr is a string representing the IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64"
- **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.0/24" or "2001:db8::/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 IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/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>)
Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.
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.
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>)
This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods.
podSelector 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.
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)
List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
ports is a list of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
<a name="NetworkPolicyPort"></a>
*NetworkPolicyPort describes a port to allow traffic on*
- **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.
port represents 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.
<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)
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.
endPort indicates that the range of ports from port to endPort if set, 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.
- **egress.ports.protocol** (string)
The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
@ -200,7 +200,7 @@ NetworkPolicySpec provides the specification of a NetworkPolicy
## NetworkPolicyStatus {#NetworkPolicyStatus}
NetworkPolicyStatus describe the current state of the NetworkPolicy.
NetworkPolicyStatus describes the current state of the NetworkPolicy.
<hr>
@ -210,7 +210,7 @@ NetworkPolicyStatus describe the current state of the NetworkPolicy.
*Map: unique values on key type will be kept during a merge*
Conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy. Current service state
conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy. Current service state
<a name="Condition"></a>
*Condition contains details for one aspect of the current state of this API Resource.*
@ -264,7 +264,7 @@ NetworkPolicyList is a list of NetworkPolicy objects.
- **items** ([]<a href="{{< ref "../policy-resources/network-policy-v1#NetworkPolicy" >}}">NetworkPolicy</a>), required
Items is a list of schema objects.
items is a list of schema objects.
@ -401,6 +401,11 @@ GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -469,6 +474,11 @@ GET /apis/networking.k8s.io/v1/networkpolicies
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -894,6 +904,11 @@ DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -90,7 +90,7 @@ PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.
Additional policies may be added in the future. Clients making eviction decisions should disallow eviction of unhealthy pods if they encounter an unrecognized policy in this field.
This field is alpha-level. The eviction API uses this field when the feature gate PDBUnhealthyPodEvictionPolicy is enabled (disabled by default).
This field is beta-level. The eviction API uses this field when the feature gate PDBUnhealthyPodEvictionPolicy is enabled (enabled by default).
@ -334,6 +334,11 @@ GET /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -402,6 +407,11 @@ GET /apis/policy/v1/poddisruptionbudgets
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -827,6 +837,11 @@ DELETE /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -81,14 +81,10 @@ ResourceQuotaSpec defines the desired hard limits to enforce for Quota.
- **scopeSelector.matchExpressions.operator** (string), required
Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
- **scopeSelector.matchExpressions.scopeName** (string), required
The name of the scope that the selector applies to.
- **scopeSelector.matchExpressions.values** ([]string)
@ -275,6 +271,11 @@ GET /api/v1/namespaces/{namespace}/resourcequotas
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -343,6 +344,11 @@ GET /api/v1/resourcequotas
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -768,6 +774,11 @@ DELETE /api/v1/namespaces/{namespace}/resourcequotas
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -45,8 +45,6 @@ EndpointSlice represents a subset of the endpoints that implement a service. For
- **addressType** (string), required
addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name.
- **endpoints** ([]Endpoint), required
@ -72,7 +70,7 @@ EndpointSlice represents a subset of the endpoints that implement a service. For
- **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, except when the normal readiness behavior is being explicitly overridden, for example when the associated Service has set the publishNotReadyAddresses flag.
- **endpoints.conditions.serving** (boolean)
@ -133,19 +131,26 @@ EndpointSlice represents a subset of the endpoints that implement a service. For
- **ports.port** (int32)
The port number of the endpoint. If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer.
port represents the port number of the endpoint. If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer.
- **ports.protocol** (string)
The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.
protocol represents the IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.
- **ports.name** (string)
The name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is dervied from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string.
name represents the name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is dervied from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string.
- **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 https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either:
* Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names:
* 'kubernetes.io/h2c' - HTTP/2 over cleartext as described in https://www.rfc-editor.org/rfc/rfc7540
* Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.
@ -169,7 +174,7 @@ EndpointSliceList represents a list of endpoint slices
- **items** ([]<a href="{{< ref "../service-resources/endpoint-slice-v1#EndpointSlice" >}}">EndpointSlice</a>), required
List of endpoint slices
items is the list of endpoint slices
@ -273,6 +278,11 @@ GET /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -341,6 +351,11 @@ GET /apis/discovery.k8s.io/v1/endpointslices
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -651,6 +666,11 @@ DELETE /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -80,7 +80,7 @@ Endpoints is a collection of endpoints that implement the actual service. Exampl
- **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 or ::1), link-local (169.254.0.0/16 or fe80::/10), or link-local multicast (224.0.0.0/24 or ff02::/16).
- **subsets.addresses.hostname** (string)
@ -103,7 +103,7 @@ Endpoints is a collection of endpoints that implement the actual service. Exampl
- **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 or ::1), link-local (169.254.0.0/16 or fe80::/10), or link-local multicast (224.0.0.0/24 or ff02::/16).
- **subsets.notReadyAddresses.hostname** (string)
@ -131,8 +131,6 @@ Endpoints is a collection of endpoints that implement the actual service. Exampl
- **subsets.ports.protocol** (string)
The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.
- **subsets.ports.name** (string)
@ -140,7 +138,14 @@ Endpoints is a collection of endpoints that implement the actual service. Exampl
- **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 https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either:
* Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).
* Kubernetes-defined prefixed names:
* 'kubernetes.io/h2c' - HTTP/2 over cleartext as described in https://www.rfc-editor.org/rfc/rfc7540
* Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.
@ -268,6 +273,11 @@ GET /api/v1/namespaces/{namespace}/endpoints
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -336,6 +346,11 @@ GET /api/v1/endpoints
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -646,6 +661,11 @@ DELETE /api/v1/namespaces/{namespace}/endpoints
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -44,7 +44,7 @@ IngressClass represents the class of the Ingress, referenced by the Ingress Spec
- **spec** (<a href="{{< ref "../service-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
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
@ -58,34 +58,34 @@ IngressClassSpec provides information about the class of an Ingress.
- **controller** (string)
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.
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 is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.
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.
kind is the type of resource being referenced.
- **parameters.name** (string), required
Name is the name of resource being referenced.
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.
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".
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".
scope represents if this refers to a cluster or namespace scoped resource. This may be set to "Cluster" (default) or "Namespace".
@ -109,7 +109,7 @@ IngressClassList is a collection of IngressClasses.
- **items** ([]<a href="{{< ref "../service-resources/ingress-class-v1#IngressClass" >}}">IngressClass</a>), required
Items is the list of IngressClasses.
items is the list of IngressClasses.
@ -203,6 +203,11 @@ GET /apis/networking.k8s.io/v1/ingressclasses
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -488,6 +493,11 @@ DELETE /apis/networking.k8s.io/v1/ingressclasses
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -44,11 +44,11 @@ Ingress is a collection of rules that allow inbound connections to reach the end
- **spec** (<a href="{{< ref "../service-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
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 is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
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
@ -62,31 +62,31 @@ IngressSpec describes the Ingress the user wishes to exist.
- **defaultBackend** (<a href="{{< ref "../service-resources/ingress-v1#IngressBackend" >}}">IngressBackend</a>)
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.
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.
- **ingressClassName** (string)
IngressClassName is the name of an IngressClass cluster resource. Ingress controller implementations use this field to know whether they should be serving this Ingress resource, by a transitive connection (controller -> IngressClass -> Ingress resource). Although the `kubernetes.io/ingress.class` annotation (simple constant name) was never formally defined, it was widely supported by Ingress controllers to create a direct binding between Ingress controller and Ingress resources. Newly created Ingress resources should prefer using the field. However, even though the annotation is officially deprecated, for backwards compatibility reasons, ingress controllers should still honor that annotation if present.
ingressClassName is the name of an IngressClass cluster resource. Ingress controller implementations use this field to know whether they should be serving this Ingress resource, by a transitive connection (controller -> IngressClass -> Ingress resource). Although the `kubernetes.io/ingress.class` annotation (simple constant name) was never formally defined, it was widely supported by Ingress controllers to create a direct binding between Ingress controller and Ingress resources. Newly created Ingress resources should prefer using the field. However, even though the annotation is officially deprecated, for backwards compatibility reasons, ingress controllers should still honor that annotation if present.
- **rules** ([]IngressRule)
*Atomic: will be replaced during a merge*
A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.
rules is a list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.
<a name="IngressRule"></a>
*IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.*
- **rules.host** (string)
Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to
host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to
the IP in the Spec of the parent Ingress.
2. The `:` delimiter is not respected because ports are not allowed.
Currently the port of an Ingress is implicitly :80 for http and
:443 for https.
Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue.
Host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If Host is precise, the request matches this rule if the http host header is equal to Host. 2. If Host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule.
host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If host is precise, the request matches this rule if the http host header is equal to Host. 2. If host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule.
- **rules.http** (HTTPIngressRuleValue)
@ -98,18 +98,18 @@ IngressSpec describes the Ingress the user wishes to exist.
*Atomic: will be replaced during a merge*
A collection of paths that map requests to backends.
paths is 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.*
- **rules.http.paths.backend** (<a href="{{< ref "../service-resources/ingress-v1#IngressBackend" >}}">IngressBackend</a>), 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.pathType** (string), required
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
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
@ -123,26 +123,26 @@ IngressSpec describes the Ingress the user wishes to exist.
- **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 '/' and must be present when using PathType with value "Exact" or "Prefix".
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 '/' and must be present when using PathType with value "Exact" or "Prefix".
- **tls** ([]IngressTLS)
*Atomic: will be replaced during a merge*
TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.
tls represents the TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.
<a name="IngressTLS"></a>
*IngressTLS describes the transport layer security associated with an Ingress.*
*IngressTLS describes the transport layer security associated with an ingress.*
- **tls.hosts** ([]string)
*Atomic: will be replaced during a merge*
Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.
hosts is a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.
- **tls.secretName** (string)
SecretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing.
secretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the "Host" header is used for routing.
@ -156,33 +156,33 @@ IngressBackend describes all endpoints for a given service and port.
- **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".
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".
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.
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.
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".
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".
number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name".
@ -196,48 +196,46 @@ IngressStatus describe the current state of the Ingress.
- **loadBalancer** (IngressLoadBalancerStatus)
LoadBalancer contains the current status of the load-balancer.
loadBalancer contains the current status of the load-balancer.
<a name="IngressLoadBalancerStatus"></a>
*IngressLoadBalancerStatus represents the status of a load-balancer.*
- **loadBalancer.ingress** ([]IngressLoadBalancerIngress)
Ingress is a list containing ingress points for the load-balancer.
ingress is a list containing ingress points for the load-balancer.
<a name="IngressLoadBalancerIngress"></a>
*IngressLoadBalancerIngress represents the status of a load-balancer ingress point.*
- **loadBalancer.ingress.hostname** (string)
Hostname is set for load-balancer ingress points that are DNS based.
hostname is set for load-balancer ingress points that are DNS based.
- **loadBalancer.ingress.ip** (string)
IP is set for load-balancer ingress points that are IP based.
ip is set for load-balancer ingress points that are IP based.
- **loadBalancer.ingress.ports** ([]IngressPortStatus)
*Atomic: will be replaced during a merge*
Ports provides information about the ports exposed by this LoadBalancer.
ports provides information about the ports exposed by this LoadBalancer.
<a name="IngressPortStatus"></a>
*IngressPortStatus represents the error condition of a service port*
- **loadBalancer.ingress.ports.port** (int32), required
Port is the port number of the ingress port.
port is the port number of the ingress port.
- **loadBalancer.ingress.ports.protocol** (string), required
Protocol is the protocol of the ingress port. The supported values are: "TCP", "UDP", "SCTP"
protocol is the protocol of the ingress port. The supported values are: "TCP", "UDP", "SCTP"
- **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
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.
@ -254,7 +252,7 @@ IngressList is a collection of Ingress.
- **items** ([]<a href="{{< ref "../service-resources/ingress-v1#Ingress" >}}">Ingress</a>), required
Items is the list of Ingress.
items is the list of Ingress.
- **apiVersion** (string)
@ -403,6 +401,11 @@ GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -471,6 +474,11 @@ GET /apis/networking.k8s.io/v1/ingresses
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -896,6 +904,11 @@ DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -89,8 +89,6 @@ ServiceSpec describes the attributes that a user creates on a service.
- **ports.protocol** (string)
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.
- **ports.name** (string)
@ -107,8 +105,6 @@ ServiceSpec describes the attributes that a user creates on a service.
- **type** (string)
type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
- **ipFamilies** ([]string)
@ -141,8 +137,6 @@ ServiceSpec describes the attributes that a user creates on a service.
- **sessionAffinity** (string)
Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
- **loadBalancerIP** (string)
@ -163,8 +157,6 @@ ServiceSpec describes the attributes that a user creates on a service.
- **externalTrafficPolicy** (string)
externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get "Cluster" semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node.
- **internalTrafficPolicy** (string)
@ -286,8 +278,6 @@ ServiceStatus represents the current status of a service.
- **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"
- **loadBalancer.ingress.ports.error** (string)
@ -455,6 +445,11 @@ GET /api/v1/namespaces/{namespace}/services
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -523,6 +518,11 @@ GET /api/v1/services
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -948,6 +948,11 @@ DELETE /api/v1/namespaces/{namespace}/services
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -216,6 +216,11 @@ GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -284,6 +289,11 @@ GET /apis/apps/v1/controllerrevisions
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -594,6 +604,11 @@ DELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisions
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -81,13 +81,13 @@ CronJobSpec describes how the job execution will look like and when it will actu
- **timeZone** (string)
The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will default to the time zone of the kube-controller-manager process. The set of valid time zone names and the time zone offset is loaded from the system-wide time zone database by the API server during CronJob validation and the controller manager during execution. If no system-wide time zone database can be found a bundled version of the database is used instead. If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host configuration, the controller will stop creating new new Jobs and will create a system event with the reason UnknownTimeZone. More information can be found in https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones This is beta field and must be enabled via the `CronJobTimeZone` feature gate.
The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will default to the time zone of the kube-controller-manager process. The set of valid time zone names and the time zone offset is loaded from the system-wide time zone database by the API server during CronJob validation and the controller manager during execution. If no system-wide time zone database can be found a bundled version of the database is used instead. If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host configuration, the controller will stop creating new new Jobs and will create a system event with the reason UnknownTimeZone. More information can be found in https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones
- **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
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
- **startingDeadlineSeconds** (int64)
@ -294,6 +294,11 @@ GET /apis/batch/v1/namespaces/{namespace}/cronjobs
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -362,6 +367,11 @@ GET /apis/batch/v1/cronjobs
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -787,6 +797,11 @@ DELETE /apis/batch/v1/namespaces/{namespace}/cronjobs
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -66,7 +66,7 @@ DaemonSetSpec is the specification of a daemon set.
- **template** (<a href="{{< ref "../workload-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
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). The only allowed template.spec.restartPolicy value is "Always". More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
- **minReadySeconds** (int32)
@ -82,8 +82,6 @@ DaemonSetSpec is the specification of a daemon set.
- **updateStrategy.type** (string)
Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
- **updateStrategy.rollingUpdate** (RollingUpdateDaemonSet)
@ -347,6 +345,11 @@ GET /apis/apps/v1/namespaces/{namespace}/daemonsets
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -415,6 +418,11 @@ GET /apis/apps/v1/daemonsets
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -840,6 +848,11 @@ DELETE /apis/apps/v1/namespaces/{namespace}/daemonsets
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -66,7 +66,7 @@ DeploymentSpec is the specification of the desired behavior of the Deployment.
- **template** (<a href="{{< ref "../workload-resources/pod-template-v1#PodTemplateSpec" >}}">PodTemplateSpec</a>), required
Template describes the pods that will be created.
Template describes the pods that will be created. The only allowed template.spec.restartPolicy value is "Always".
- **replicas** (int32)
@ -88,8 +88,6 @@ DeploymentSpec is the specification of the desired behavior of the Deployment.
- **strategy.type** (string)
Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
- **strategy.rollingUpdate** (RollingUpdateDeployment)
@ -360,6 +358,11 @@ GET /apis/apps/v1/namespaces/{namespace}/deployments
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -428,6 +431,11 @@ GET /apis/apps/v1/deployments
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -853,6 +861,11 @@ DELETE /apis/apps/v1/namespaces/{namespace}/deployments
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -44,11 +44,11 @@ configuration of a horizontal pod autoscaler.
- **spec** (<a href="{{< ref "../workload-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.
spec defines the 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>)
current information about the autoscaler.
status is the current information about the autoscaler.
@ -62,7 +62,7 @@ specification of a horizontal pod autoscaler.
- **maxReplicas** (int32), required
upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.
maxReplicas is the upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.
- **scaleTargetRef** (CrossVersionObjectReference), required
@ -73,15 +73,15 @@ specification of a horizontal pod autoscaler.
- **scaleTargetRef.kind** (string), required
Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **scaleTargetRef.name** (string), required
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **scaleTargetRef.apiVersion** (string)
API version of the referent
apiVersion is the API version of the referent
- **minReplicas** (int32)
@ -89,7 +89,7 @@ specification of a horizontal pod autoscaler.
- **targetCPUUtilizationPercentage** (int32)
target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.
targetCPUUtilizationPercentage is the target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.
@ -103,26 +103,26 @@ current status of a horizontal pod autoscaler
- **currentReplicas** (int32), required
current number of replicas of pods managed by this autoscaler.
currentReplicas is the current number of replicas of pods managed by this autoscaler.
- **desiredReplicas** (int32), required
desired number of replicas of pods managed by this autoscaler.
desiredReplicas is the desired number of replicas of pods managed by this autoscaler.
- **currentCPUUtilizationPercentage** (int32)
current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.
currentCPUUtilizationPercentage is the current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.
- **lastScaleTime** (Time)
last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.
lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.
<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.*
- **observedGeneration** (int64)
most recent generation observed by this autoscaler.
observedGeneration is the most recent generation observed by this autoscaler.
@ -146,7 +146,7 @@ list of horizontal pod autoscaler objects.
- **items** ([]<a href="{{< ref "../workload-resources/horizontal-pod-autoscaler-v1#HorizontalPodAutoscaler" >}}">HorizontalPodAutoscaler</a>), required
list of horizontal pod autoscaler objects.
items is the list of horizontal pod autoscaler objects.
@ -283,6 +283,11 @@ GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -351,6 +356,11 @@ GET /apis/autoscaling/v1/horizontalpodautoscalers
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -776,6 +786,11 @@ DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -73,15 +73,15 @@ HorizontalPodAutoscalerSpec describes the desired functionality of the Horizonta
- **scaleTargetRef.kind** (string), required
Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- **scaleTargetRef.name** (string), required
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **scaleTargetRef.apiVersion** (string)
API version of the referent
apiVersion is the API version of the referent
- **minReplicas** (int32)
@ -112,15 +112,15 @@ HorizontalPodAutoscalerSpec describes the desired functionality of the Horizonta
- **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
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
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)
@ -128,7 +128,7 @@ HorizontalPodAutoscalerSpec describes the desired functionality of the Horizonta
- **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)
@ -151,15 +151,15 @@ HorizontalPodAutoscalerSpec describes the desired functionality of the Horizonta
- **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
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
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)
@ -167,7 +167,7 @@ HorizontalPodAutoscalerSpec describes the desired functionality of the Horizonta
- **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)
@ -281,15 +281,15 @@ HorizontalPodAutoscalerSpec describes the desired functionality of the Horizonta
- **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 is the 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
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **metrics.object.describedObject.apiVersion** (string)
API version of the referent
apiVersion is the API version of the referent
- **metrics.object.metric** (MetricIdentifier), required
@ -478,7 +478,7 @@ HorizontalPodAutoscalerStatus describes the current status of a horizontal pod a
- **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
@ -501,7 +501,7 @@ HorizontalPodAutoscalerStatus describes the current status of a horizontal pod a
- **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)
@ -579,15 +579,15 @@ HorizontalPodAutoscalerStatus describes the current status of a horizontal pod a
- **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 is the 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
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- **currentMetrics.object.describedObject.apiVersion** (string)
API version of the referent
apiVersion is the API version of the referent
- **currentMetrics.object.metric** (MetricIdentifier), required
@ -673,7 +673,7 @@ HorizontalPodAutoscalerStatus describes the current status of a horizontal pod a
- **currentMetrics.resource.name** (string), required
Name is the name of the resource in question.
name is the name of the resource in question.
- **currentReplicas** (int32)
@ -849,6 +849,11 @@ GET /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -917,6 +922,11 @@ GET /apis/autoscaling/v2/horizontalpodautoscalers
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -1342,6 +1352,11 @@ DELETE /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -67,7 +67,7 @@ JobSpec describes how the job execution will look like.
- **template** (<a href="{{< ref "../workload-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/
Describes the pod that will be created when executing a job. The only allowed template.spec.restartPolicy values are "Never" or "OnFailure". More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
- **parallelism** (int32)
@ -78,11 +78,11 @@ JobSpec describes how the job execution will look like.
- **completions** (int32)
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/
Specifies the desired number of successfully finished pods the job should be run with. Setting to null 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`.
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.
@ -104,7 +104,7 @@ JobSpec describes how the job execution will look like.
- **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. Defaults to false.
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. Defaults to false.
### Selector
@ -136,11 +136,12 @@ JobSpec describes how the job execution will look like.
A list of pod failure policy rules. The rules are evaluated in order. Once a rule matches a Pod failure, the remaining of the rules are ignored. When no rule matches the Pod failure, the default handling applies - the counter of pod failures is incremented and it is checked against the backoffLimit. At most 20 elements are allowed.
<a name="PodFailurePolicyRule"></a>
*PodFailurePolicyRule describes how a pod failure is handled when the requirements are met. One of OnExitCodes and onPodConditions, but not both, can be used in each rule.*
*PodFailurePolicyRule describes how a pod failure is handled when the requirements are met. One of onExitCodes and onPodConditions, but not both, can be used in each rule.*
- **podFailurePolicy.rules.action** (string), required
Specifies the action taken on a pod failure when the requirements are satisfied. Possible values are:
- FailJob: indicates that the pod's job is marked as Failed and all
running pods are terminated.
- Ignore: indicates that the counter towards the .backoffLimit is not
@ -148,8 +149,6 @@ JobSpec describes how the job execution will look like.
- Count: indicates that the pod is handled in the default way - the
counter towards the .backoffLimit is incremented.
Additional values are considered to be added in the future. Clients should react to an unknown action by skipping the rule.
- **podFailurePolicy.rules.onPodConditions** ([]PodFailurePolicyOnPodConditionsPattern), required
@ -178,6 +177,7 @@ JobSpec describes how the job execution will look like.
- **podFailurePolicy.rules.onExitCodes.operator** (string), required
Represents the relationship between the container exit code(s) and the specified values. Containers completed with success (exit code 0) are excluded from the requirement check. Possible values are:
- In: the requirement is satisfied if at least one container exit code
(might be multiple if there are multiple containers not restricted
by the 'containerName' field) is in the set of specified values.
@ -185,8 +185,6 @@ JobSpec describes how the job execution will look like.
(might be multiple if there are multiple containers not restricted
by the 'containerName' field) is not in the set of specified values.
Additional values are considered to be added in the future. Clients should react to an unknown operator by assuming the requirement is not satisfied.
- **podFailurePolicy.rules.onExitCodes.values** ([]int32), required
@ -234,7 +232,7 @@ JobStatus represents the current state of a Job.
- **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".
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)
@ -279,9 +277,11 @@ JobStatus represents the current state of a Job.
- **uncountedTerminatedPods** (UncountedTerminatedPods)
UncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn't yet accounted for in the status counters.
uncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn't yet accounted for in the status counters.
The job controller creates pods with a finalizer. When a pod terminates (succeeded or failed), the controller does three steps to account for it in the job status: (1) Add the pod UID to the arrays in this field. (2) Remove the pod finalizer. (3) Remove the pod UID from the arrays while increasing the corresponding
The job controller creates pods with a finalizer. When a pod terminates (succeeded or failed), the controller does three steps to account for it in the job status:
1. Add the pod UID to the arrays in this field. 2. Remove the pod finalizer. 3. Remove the pod UID from the arrays while increasing the corresponding
counter.
Old jobs might not be tracked using this field, in which case the field remains null.
@ -293,13 +293,13 @@ JobStatus represents the current state of a Job.
*Set: unique values will be kept during a merge*
Failed holds UIDs of failed Pods.
failed holds UIDs of failed Pods.
- **uncountedTerminatedPods.succeeded** ([]string)
*Set: unique values will be kept during a merge*
Succeeded holds UIDs of succeeded Pods.
succeeded holds UIDs of succeeded Pods.
@ -469,6 +469,11 @@ GET /apis/batch/v1/namespaces/{namespace}/jobs
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -537,6 +542,11 @@ GET /apis/batch/v1/jobs
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -962,6 +972,11 @@ DELETE /apis/batch/v1/namespaces/{namespace}/jobs
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -1,11 +1,11 @@
---
api_metadata:
apiVersion: "resource.k8s.io/v1alpha1"
import: "k8s.io/api/resource/v1alpha1"
kind: "PodScheduling"
apiVersion: "resource.k8s.io/v1alpha2"
import: "k8s.io/api/resource/v1alpha2"
kind: "PodSchedulingContext"
content_type: "api_reference"
description: "PodScheduling objects hold information that is needed to schedule a Pod with ResourceClaims that use \"WaitForFirstConsumer\" allocation mode."
title: "PodScheduling v1alpha1"
description: "PodSchedulingContext objects hold information that is needed to schedule a Pod with ResourceClaims that use \"WaitForFirstConsumer\" allocation mode."
title: "PodSchedulingContext v1alpha2"
weight: 14
auto_generated: true
---
@ -21,34 +21,34 @@ guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
`apiVersion: resource.k8s.io/v1alpha1`
`apiVersion: resource.k8s.io/v1alpha2`
`import "k8s.io/api/resource/v1alpha1"`
`import "k8s.io/api/resource/v1alpha2"`
## PodScheduling {#PodScheduling}
## PodSchedulingContext {#PodSchedulingContext}
PodScheduling objects hold information that is needed to schedule a Pod with ResourceClaims that use "WaitForFirstConsumer" allocation mode.
PodSchedulingContext objects hold information that is needed to schedule a Pod with ResourceClaims that use "WaitForFirstConsumer" allocation mode.
This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
<hr>
- **apiVersion**: resource.k8s.io/v1alpha1
- **apiVersion**: resource.k8s.io/v1alpha2
- **kind**: PodScheduling
- **kind**: PodSchedulingContext
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
Standard object metadata
- **spec** (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodSchedulingSpec" >}}">PodSchedulingSpec</a>), required
- **spec** (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContextSpec" >}}">PodSchedulingContextSpec</a>), required
Spec describes where resources for the Pod are needed.
- **status** (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodSchedulingStatus" >}}">PodSchedulingStatus</a>)
- **status** (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContextStatus" >}}">PodSchedulingContextStatus</a>)
Status describes where resources for the Pod can be allocated.
@ -56,9 +56,9 @@ This is an alpha type and requires enabling the DynamicResourceAllocation featur
## PodSchedulingSpec {#PodSchedulingSpec}
## PodSchedulingContextSpec {#PodSchedulingContextSpec}
PodSchedulingSpec describes where resources for the Pod are needed.
PodSchedulingContextSpec describes where resources for the Pod are needed.
<hr>
@ -78,9 +78,9 @@ PodSchedulingSpec describes where resources for the Pod are needed.
## PodSchedulingStatus {#PodSchedulingStatus}
## PodSchedulingContextStatus {#PodSchedulingContextStatus}
PodSchedulingStatus describes where resources for the Pod can be allocated.
PodSchedulingContextStatus describes where resources for the Pod can be allocated.
<hr>
@ -109,25 +109,25 @@ PodSchedulingStatus describes where resources for the Pod can be allocated.
## PodSchedulingList {#PodSchedulingList}
## PodSchedulingContextList {#PodSchedulingContextList}
PodSchedulingList is a collection of Pod scheduling objects.
PodSchedulingContextList is a collection of Pod scheduling objects.
<hr>
- **apiVersion**: resource.k8s.io/v1alpha1
- **apiVersion**: resource.k8s.io/v1alpha2
- **kind**: PodSchedulingList
- **kind**: PodSchedulingContextList
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
Standard list metadata
- **items** ([]<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>), required
- **items** ([]<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>), required
Items is the list of PodScheduling objects.
Items is the list of PodSchedulingContext objects.
@ -144,18 +144,18 @@ PodSchedulingList is a collection of Pod scheduling objects.
### `get` read the specified PodScheduling
### `get` read the specified PodSchedulingContext
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings/{name}
GET /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PodScheduling
name of the PodSchedulingContext
- **namespace** (*in path*): string, required
@ -172,23 +172,23 @@ GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>): OK
200 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>): OK
401: Unauthorized
### `get` read status of the specified PodScheduling
### `get` read status of the specified PodSchedulingContext
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings/{name}/status
GET /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PodScheduling
name of the PodSchedulingContext
- **namespace** (*in path*): string, required
@ -205,16 +205,16 @@ GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings/{name}/
#### Response
200 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>): OK
200 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>): OK
401: Unauthorized
### `list` list or watch objects of kind PodScheduling
### `list` list or watch objects of kind PodSchedulingContext
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings
GET /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts
#### Parameters
@ -264,6 +264,11 @@ GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -278,16 +283,16 @@ GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings
#### Response
200 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodSchedulingList" >}}">PodSchedulingList</a>): OK
200 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContextList" >}}">PodSchedulingContextList</a>): OK
401: Unauthorized
### `list` list or watch objects of kind PodScheduling
### `list` list or watch objects of kind PodSchedulingContext
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha1/podschedulings
GET /apis/resource.k8s.io/v1alpha2/podschedulingcontexts
#### Parameters
@ -332,6 +337,11 @@ GET /apis/resource.k8s.io/v1alpha1/podschedulings
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -346,16 +356,16 @@ GET /apis/resource.k8s.io/v1alpha1/podschedulings
#### Response
200 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodSchedulingList" >}}">PodSchedulingList</a>): OK
200 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContextList" >}}">PodSchedulingContextList</a>): OK
401: Unauthorized
### `create` create a PodScheduling
### `create` create a PodSchedulingContext
#### HTTP Request
POST /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings
POST /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts
#### Parameters
@ -365,7 +375,7 @@ POST /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>, required
- **body**: <a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>, required
@ -394,27 +404,27 @@ POST /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings
#### Response
200 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>): OK
200 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>): OK
201 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>): Created
201 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>): Created
202 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>): Accepted
202 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>): Accepted
401: Unauthorized
### `update` replace the specified PodScheduling
### `update` replace the specified PodSchedulingContext
#### HTTP Request
PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings/{name}
PUT /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PodScheduling
name of the PodSchedulingContext
- **namespace** (*in path*): string, required
@ -422,7 +432,7 @@ PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>, required
- **body**: <a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>, required
@ -451,25 +461,25 @@ PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>): OK
200 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>): OK
201 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>): Created
201 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>): Created
401: Unauthorized
### `update` replace status of the specified PodScheduling
### `update` replace status of the specified PodSchedulingContext
#### HTTP Request
PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings/{name}/status
PUT /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PodScheduling
name of the PodSchedulingContext
- **namespace** (*in path*): string, required
@ -477,7 +487,7 @@ PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings/{name}/
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>, required
- **body**: <a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>, required
@ -506,25 +516,25 @@ PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings/{name}/
#### Response
200 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>): OK
200 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>): OK
201 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>): Created
201 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>): Created
401: Unauthorized
### `patch` partially update the specified PodScheduling
### `patch` partially update the specified PodSchedulingContext
#### HTTP Request
PATCH /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings/{name}
PATCH /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PodScheduling
name of the PodSchedulingContext
- **namespace** (*in path*): string, required
@ -566,25 +576,25 @@ PATCH /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings/{name
#### Response
200 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>): OK
200 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>): OK
201 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>): Created
201 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>): Created
401: Unauthorized
### `patch` partially update status of the specified PodScheduling
### `patch` partially update status of the specified PodSchedulingContext
#### HTTP Request
PATCH /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings/{name}/status
PATCH /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts/{name}/status
#### Parameters
- **name** (*in path*): string, required
name of the PodScheduling
name of the PodSchedulingContext
- **namespace** (*in path*): string, required
@ -626,25 +636,25 @@ PATCH /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings/{name
#### Response
200 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>): OK
200 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>): OK
201 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>): Created
201 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>): Created
401: Unauthorized
### `delete` delete a PodScheduling
### `delete` delete a PodSchedulingContext
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings/{name}
DELETE /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts/{name}
#### Parameters
- **name** (*in path*): string, required
name of the PodScheduling
name of the PodSchedulingContext
- **namespace** (*in path*): string, required
@ -681,18 +691,18 @@ DELETE /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings/{nam
#### Response
200 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>): OK
200 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>): OK
202 (<a href="{{< ref "../workload-resources/pod-scheduling-v1alpha1#PodScheduling" >}}">PodScheduling</a>): Accepted
202 (<a href="{{< ref "../workload-resources/pod-scheduling-context-v1alpha2#PodSchedulingContext" >}}">PodSchedulingContext</a>): Accepted
401: Unauthorized
### `deletecollection` delete collection of PodScheduling
### `deletecollection` delete collection of PodSchedulingContext
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings
DELETE /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/podschedulingcontexts
#### Parameters
@ -757,6 +767,11 @@ DELETE /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/podschedulings
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -190,6 +190,11 @@ GET /api/v1/namespaces/{namespace}/podtemplates
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -258,6 +263,11 @@ GET /api/v1/podtemplates
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -568,6 +578,11 @@ DELETE /api/v1/namespaces/{namespace}/podtemplates
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -161,8 +161,6 @@ PodSpec is a description of a pod.
- **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.
- **tolerations.value** (string)
@ -171,8 +169,6 @@ PodSpec is a description of a pod.
- **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.
- **tolerations.tolerationSeconds** (int64)
@ -219,15 +215,10 @@ PodSpec is a description of a pod.
- **topologySpreadConstraints.whenUnsatisfiable** (string), required
WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint.
- DoNotSchedule (default) tells the scheduler not to schedule it.
- ScheduleAnyway tells the scheduler to schedule the pod in any location,
WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,
but giving higher precedence to topologies that would help reduce the
skew.
A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.
- **topologySpreadConstraints.labelSelector** (<a href="{{< ref "../common-definitions/label-selector#LabelSelector" >}}">LabelSelector</a>)
@ -237,7 +228,9 @@ PodSpec is a description of a pod.
*Atomic: will be replaced during a merge*
MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector.
MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector.
This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
- **topologySpreadConstraints.minDomains** (int32)
@ -268,9 +261,7 @@ PodSpec is a description of a pod.
- **restartPolicy** (string)
Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
Restart policy for all containers within the pod. One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
- **terminationGracePeriodSeconds** (int64)
@ -355,8 +346,6 @@ PodSpec is a description of a pod.
- **dnsPolicy** (string)
Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
### Hosts namespaces
@ -438,8 +427,6 @@ PodSpec is a description of a pod.
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)
@ -561,9 +548,11 @@ PodSpec is a description of a pod.
*Map: unique values on key name will be kept during a merge*
SchedulingGates is an opaque list of values that if specified will block scheduling the pod. More info: https://git.k8s.io/enhancements/keps/sig-scheduling/3521-pod-scheduling-readiness.
SchedulingGates is an opaque list of values that if specified will block scheduling the pod. If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the scheduler will not attempt to schedule the pod.
This is an alpha-level feature enabled by PodSchedulingReadiness feature gate.
SchedulingGates can only be set at pod creation time, and be removed only afterwards.
This is a beta feature enabled by the PodSchedulingReadiness feature gate.
<a name="PodSchedulingGate"></a>
*PodSchedulingGate is associated to a Pod to guard its scheduling.*
@ -603,8 +592,6 @@ A single application container that you want to run within a pod.
- **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
@ -654,8 +641,6 @@ A single application container that you want to run within a pod.
- **ports.protocol** (string)
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
### Environment variables
@ -840,13 +825,13 @@ A single application container that you want to run within a pod.
- **resources.claims** ([]ResourceClaim)
*Set: unique values will be kept during a merge*
*Map: unique values on key name will be kept during a merge*
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable.
This field is immutable. It can only be set for containers.
<a name="ResourceClaim"></a>
*ResourceClaim references one entry in PodSpec.ResourceClaims.*
@ -861,7 +846,24 @@ A single application container that you want to run within a pod.
- **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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- **resizePolicy** ([]ContainerResizePolicy)
*Atomic: will be replaced during a merge*
Resources resize policy for the container.
<a name="ContainerResizePolicy"></a>
*ContainerResizePolicy represents resource resize policy for the container.*
- **resizePolicy.resourceName** (string), required
Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
- **resizePolicy.restartPolicy** (string), required
Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.
### Lifecycle
@ -888,8 +890,6 @@ A single application container that you want to run within a pod.
- **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** (<a href="{{< ref "../workload-resources/pod-v1#Probe" >}}">Probe</a>)
@ -968,8 +968,6 @@ A single application container that you want to run within a pod.
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)
@ -1068,8 +1066,6 @@ To add an ephemeral container, use the ephemeralcontainers subresource of an exi
- **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
@ -1257,6 +1253,26 @@ To add an ephemeral container, use the ephemeralcontainers subresource of an exi
name must match the name of a persistentVolumeClaim in the pod
### Resources
- **resizePolicy** ([]ContainerResizePolicy)
*Atomic: will be replaced during a merge*
Resources resize policy for the container.
<a name="ContainerResizePolicy"></a>
*ContainerResizePolicy represents resource resize policy for the container.*
- **resizePolicy.resourceName** (string), required
Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
- **resizePolicy.restartPolicy** (string), required
Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.
### Lifecycle
@ -1267,8 +1283,6 @@ To add an ephemeral container, use the ephemeralcontainers subresource of an exi
- **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.
### Debugging
@ -1350,8 +1364,6 @@ To add an ephemeral container, use the ephemeralcontainers subresource of an exi
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)
@ -1436,8 +1448,6 @@ To add an ephemeral container, use the ephemeralcontainers subresource of an exi
- **ports.protocol** (string)
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
- **resources** (ResourceRequirements)
@ -1448,13 +1458,13 @@ To add an ephemeral container, use the ephemeralcontainers subresource of an exi
- **resources.claims** ([]ResourceClaim)
*Set: unique values will be kept during a merge*
*Map: unique values on key name will be kept during a merge*
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.
This field is immutable.
This field is immutable. It can only be set for containers.
<a name="ResourceClaim"></a>
*ResourceClaim references one entry in PodSpec.ResourceClaims.*
@ -1469,7 +1479,7 @@ To add an ephemeral container, use the ephemeralcontainers subresource of an exi
- **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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- **lifecycle** (Lifecycle)
@ -1557,8 +1567,6 @@ LifecycleHandler defines a specific action that should be taken in a lifecycle h
- **httpGet.scheme** (string)
Scheme to use for connecting to the host. Defaults to HTTP.
- **tcpSocket** (TCPSocketAction)
@ -1831,8 +1839,6 @@ Probe describes a health check to be performed against a container to determine
- **httpGet.scheme** (string)
Scheme to use for connecting to the host. Defaults to HTTP.
- **tcpSocket** (TCPSocketAction)
@ -1878,7 +1884,7 @@ Probe describes a health check to be performed against a container to determine
- **grpc** (GRPCAction)
GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
GRPC specifies an action involving a GRPC port.
<a name="GRPCAction"></a>
**
@ -1925,8 +1931,6 @@ PodStatus represents information about the status of a pod. Status may trail the
Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase
- **message** (string)
@ -1996,9 +2000,7 @@ PodStatus represents information about the status of a pod. Status may trail the
- **qosClass** (string)
The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md
The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/#quality-of-service-classes
- **initContainerStatuses** ([]ContainerStatus)
@ -2007,188 +2009,6 @@ PodStatus represents information about the status of a pod. Status may trail the
<a name="ContainerStatus"></a>
*ContainerStatus contains details for the current status of this container.*
- **initContainerStatuses.name** (string), required
This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
- **initContainerStatuses.image** (string), required
The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images.
- **initContainerStatuses.imageID** (string), required
ImageID of the container's image.
- **initContainerStatuses.containerID** (string)
Container's ID in the format '\<type>://\<container_id>'.
- **initContainerStatuses.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.*
- **initContainerStatuses.state.running** (ContainerStateRunning)
Details about a running container
<a name="ContainerStateRunning"></a>
*ContainerStateRunning is a running state of a container.*
- **initContainerStatuses.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.*
- **initContainerStatuses.state.terminated** (ContainerStateTerminated)
Details about a terminated container
<a name="ContainerStateTerminated"></a>
*ContainerStateTerminated is a terminated state of a container.*
- **initContainerStatuses.state.terminated.containerID** (string)
Container's ID in the format '\<type>://\<container_id>'
- **initContainerStatuses.state.terminated.exitCode** (int32), required
Exit status from the last termination of the container
- **initContainerStatuses.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.*
- **initContainerStatuses.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.*
- **initContainerStatuses.state.terminated.message** (string)
Message regarding the last termination of the container
- **initContainerStatuses.state.terminated.reason** (string)
(brief) reason from the last termination of the container
- **initContainerStatuses.state.terminated.signal** (int32)
Signal from the last termination of the container
- **initContainerStatuses.state.waiting** (ContainerStateWaiting)
Details about a waiting container
<a name="ContainerStateWaiting"></a>
*ContainerStateWaiting is a waiting state of a container.*
- **initContainerStatuses.state.waiting.message** (string)
Message regarding why the container is not yet running.
- **initContainerStatuses.state.waiting.reason** (string)
(brief) reason the container is not yet running.
- **initContainerStatuses.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.*
- **initContainerStatuses.lastState.running** (ContainerStateRunning)
Details about a running container
<a name="ContainerStateRunning"></a>
*ContainerStateRunning is a running state of a container.*
- **initContainerStatuses.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.*
- **initContainerStatuses.lastState.terminated** (ContainerStateTerminated)
Details about a terminated container
<a name="ContainerStateTerminated"></a>
*ContainerStateTerminated is a terminated state of a container.*
- **initContainerStatuses.lastState.terminated.containerID** (string)
Container's ID in the format '\<type>://\<container_id>'
- **initContainerStatuses.lastState.terminated.exitCode** (int32), required
Exit status from the last termination of the container
- **initContainerStatuses.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.*
- **initContainerStatuses.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.*
- **initContainerStatuses.lastState.terminated.message** (string)
Message regarding the last termination of the container
- **initContainerStatuses.lastState.terminated.reason** (string)
(brief) reason from the last termination of the container
- **initContainerStatuses.lastState.terminated.signal** (int32)
Signal from the last termination of the container
- **initContainerStatuses.lastState.waiting** (ContainerStateWaiting)
Details about a waiting container
<a name="ContainerStateWaiting"></a>
*ContainerStateWaiting is a waiting state of a container.*
- **initContainerStatuses.lastState.waiting.message** (string)
Message regarding why the container is not yet running.
- **initContainerStatuses.lastState.waiting.reason** (string)
(brief) reason the container is not yet running.
- **initContainerStatuses.ready** (boolean), required
Specifies whether the container has passed its readiness probe.
- **initContainerStatuses.restartCount** (int32), required
The number of times the container has been restarted.
- **initContainerStatuses.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.
- **containerStatuses** ([]ContainerStatus)
The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
@ -2196,188 +2016,6 @@ PodStatus represents information about the status of a pod. Status may trail the
<a name="ContainerStatus"></a>
*ContainerStatus contains details for the current status of this container.*
- **containerStatuses.name** (string), required
This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
- **containerStatuses.image** (string), required
The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images.
- **containerStatuses.imageID** (string), required
ImageID of the container's image.
- **containerStatuses.containerID** (string)
Container's ID in the format '\<type>://\<container_id>'.
- **containerStatuses.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.*
- **containerStatuses.state.running** (ContainerStateRunning)
Details about a running container
<a name="ContainerStateRunning"></a>
*ContainerStateRunning is a running state of a container.*
- **containerStatuses.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.*
- **containerStatuses.state.terminated** (ContainerStateTerminated)
Details about a terminated container
<a name="ContainerStateTerminated"></a>
*ContainerStateTerminated is a terminated state of a container.*
- **containerStatuses.state.terminated.containerID** (string)
Container's ID in the format '\<type>://\<container_id>'
- **containerStatuses.state.terminated.exitCode** (int32), required
Exit status from the last termination of the container
- **containerStatuses.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.*
- **containerStatuses.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.*
- **containerStatuses.state.terminated.message** (string)
Message regarding the last termination of the container
- **containerStatuses.state.terminated.reason** (string)
(brief) reason from the last termination of the container
- **containerStatuses.state.terminated.signal** (int32)
Signal from the last termination of the container
- **containerStatuses.state.waiting** (ContainerStateWaiting)
Details about a waiting container
<a name="ContainerStateWaiting"></a>
*ContainerStateWaiting is a waiting state of a container.*
- **containerStatuses.state.waiting.message** (string)
Message regarding why the container is not yet running.
- **containerStatuses.state.waiting.reason** (string)
(brief) reason the container is not yet running.
- **containerStatuses.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.*
- **containerStatuses.lastState.running** (ContainerStateRunning)
Details about a running container
<a name="ContainerStateRunning"></a>
*ContainerStateRunning is a running state of a container.*
- **containerStatuses.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.*
- **containerStatuses.lastState.terminated** (ContainerStateTerminated)
Details about a terminated container
<a name="ContainerStateTerminated"></a>
*ContainerStateTerminated is a terminated state of a container.*
- **containerStatuses.lastState.terminated.containerID** (string)
Container's ID in the format '\<type>://\<container_id>'
- **containerStatuses.lastState.terminated.exitCode** (int32), required
Exit status from the last termination of the container
- **containerStatuses.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.*
- **containerStatuses.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.*
- **containerStatuses.lastState.terminated.message** (string)
Message regarding the last termination of the container
- **containerStatuses.lastState.terminated.reason** (string)
(brief) reason from the last termination of the container
- **containerStatuses.lastState.terminated.signal** (int32)
Signal from the last termination of the container
- **containerStatuses.lastState.waiting** (ContainerStateWaiting)
Details about a waiting container
<a name="ContainerStateWaiting"></a>
*ContainerStateWaiting is a waiting state of a container.*
- **containerStatuses.lastState.waiting.message** (string)
Message regarding why the container is not yet running.
- **containerStatuses.lastState.waiting.reason** (string)
(brief) reason the container is not yet running.
- **containerStatuses.ready** (boolean), required
Specifies whether the container has passed its readiness probe.
- **containerStatuses.restartCount** (int32), required
The number of times the container has been restarted.
- **containerStatuses.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.
- **ephemeralContainerStatuses** ([]ContainerStatus)
Status for any ephemeral containers that have run in this pod.
@ -2385,187 +2023,9 @@ PodStatus represents information about the status of a pod. Status may trail the
<a name="ContainerStatus"></a>
*ContainerStatus contains details for the current status of this container.*
- **ephemeralContainerStatuses.name** (string), required
- **resize** (string)
This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
- **ephemeralContainerStatuses.image** (string), required
The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images.
- **ephemeralContainerStatuses.imageID** (string), required
ImageID of the container's image.
- **ephemeralContainerStatuses.containerID** (string)
Container's ID in the format '\<type>://\<container_id>'.
- **ephemeralContainerStatuses.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.*
- **ephemeralContainerStatuses.state.running** (ContainerStateRunning)
Details about a running container
<a name="ContainerStateRunning"></a>
*ContainerStateRunning is a running state of a container.*
- **ephemeralContainerStatuses.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.*
- **ephemeralContainerStatuses.state.terminated** (ContainerStateTerminated)
Details about a terminated container
<a name="ContainerStateTerminated"></a>
*ContainerStateTerminated is a terminated state of a container.*
- **ephemeralContainerStatuses.state.terminated.containerID** (string)
Container's ID in the format '\<type>://\<container_id>'
- **ephemeralContainerStatuses.state.terminated.exitCode** (int32), required
Exit status from the last termination of the container
- **ephemeralContainerStatuses.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.*
- **ephemeralContainerStatuses.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.*
- **ephemeralContainerStatuses.state.terminated.message** (string)
Message regarding the last termination of the container
- **ephemeralContainerStatuses.state.terminated.reason** (string)
(brief) reason from the last termination of the container
- **ephemeralContainerStatuses.state.terminated.signal** (int32)
Signal from the last termination of the container
- **ephemeralContainerStatuses.state.waiting** (ContainerStateWaiting)
Details about a waiting container
<a name="ContainerStateWaiting"></a>
*ContainerStateWaiting is a waiting state of a container.*
- **ephemeralContainerStatuses.state.waiting.message** (string)
Message regarding why the container is not yet running.
- **ephemeralContainerStatuses.state.waiting.reason** (string)
(brief) reason the container is not yet running.
- **ephemeralContainerStatuses.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.*
- **ephemeralContainerStatuses.lastState.running** (ContainerStateRunning)
Details about a running container
<a name="ContainerStateRunning"></a>
*ContainerStateRunning is a running state of a container.*
- **ephemeralContainerStatuses.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.*
- **ephemeralContainerStatuses.lastState.terminated** (ContainerStateTerminated)
Details about a terminated container
<a name="ContainerStateTerminated"></a>
*ContainerStateTerminated is a terminated state of a container.*
- **ephemeralContainerStatuses.lastState.terminated.containerID** (string)
Container's ID in the format '\<type>://\<container_id>'
- **ephemeralContainerStatuses.lastState.terminated.exitCode** (int32), required
Exit status from the last termination of the container
- **ephemeralContainerStatuses.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.*
- **ephemeralContainerStatuses.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.*
- **ephemeralContainerStatuses.lastState.terminated.message** (string)
Message regarding the last termination of the container
- **ephemeralContainerStatuses.lastState.terminated.reason** (string)
(brief) reason from the last termination of the container
- **ephemeralContainerStatuses.lastState.terminated.signal** (int32)
Signal from the last termination of the container
- **ephemeralContainerStatuses.lastState.waiting** (ContainerStateWaiting)
Details about a waiting container
<a name="ContainerStateWaiting"></a>
*ContainerStateWaiting is a waiting state of a container.*
- **ephemeralContainerStatuses.lastState.waiting.message** (string)
Message regarding why the container is not yet running.
- **ephemeralContainerStatuses.lastState.waiting.reason** (string)
(brief) reason the container is not yet running.
- **ephemeralContainerStatuses.ready** (boolean), required
Specifies whether the container has passed its readiness probe.
- **ephemeralContainerStatuses.restartCount** (int32), required
The number of times the container has been restarted.
- **ephemeralContainerStatuses.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.
Status of resources resize desired for pod's containers. It is empty if no resources resize is pending. Any changes to container resources will automatically set this to "Proposed"
@ -2834,6 +2294,11 @@ GET /api/v1/namespaces/{namespace}/pods
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -2902,6 +2367,11 @@ GET /api/v1/pods
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -3442,6 +2912,11 @@ DELETE /api/v1/namespaces/{namespace}/pods
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -44,7 +44,7 @@ PriorityClass defines mapping from a priority class name to the priority integer
- **value** (int32), required
The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec.
value represents the integer value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec.
- **description** (string)
@ -56,7 +56,7 @@ PriorityClass defines mapping from a priority class name to the priority integer
- **preemptionPolicy** (string)
PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
preemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
@ -174,6 +174,11 @@ GET /apis/scheduling.k8s.io/v1/priorityclasses
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -459,6 +464,11 @@ DELETE /apis/scheduling.k8s.io/v1/priorityclasses
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -297,6 +297,11 @@ GET /apis/apps/v1/namespaces/{namespace}/replicasets
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -365,6 +370,11 @@ GET /apis/apps/v1/replicasets
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -790,6 +800,11 @@ DELETE /apis/apps/v1/namespaces/{namespace}/replicasets
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -66,7 +66,7 @@ ReplicationControllerSpec is the specification of a replication controller.
- **template** (<a href="{{< ref "../workload-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
Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. The only allowed template.spec.restartPolicy value is "Always". More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
- **replicas** (int32)
@ -297,6 +297,11 @@ GET /api/v1/namespaces/{namespace}/replicationcontrollers
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -365,6 +370,11 @@ GET /api/v1/replicationcontrollers
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -790,6 +800,11 @@ DELETE /api/v1/namespaces/{namespace}/replicationcontrollers
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -1,11 +1,11 @@
---
api_metadata:
apiVersion: "resource.k8s.io/v1alpha1"
import: "k8s.io/api/resource/v1alpha1"
apiVersion: "resource.k8s.io/v1alpha2"
import: "k8s.io/api/resource/v1alpha2"
kind: "ResourceClaimTemplate"
content_type: "api_reference"
description: "ResourceClaimTemplate is used to produce ResourceClaim objects."
title: "ResourceClaimTemplate v1alpha1"
title: "ResourceClaimTemplate v1alpha2"
weight: 16
auto_generated: true
---
@ -21,9 +21,9 @@ guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
`apiVersion: resource.k8s.io/v1alpha1`
`apiVersion: resource.k8s.io/v1alpha2`
`import "k8s.io/api/resource/v1alpha1"`
`import "k8s.io/api/resource/v1alpha2"`
## ResourceClaimTemplate {#ResourceClaimTemplate}
@ -32,7 +32,7 @@ ResourceClaimTemplate is used to produce ResourceClaim objects.
<hr>
- **apiVersion**: resource.k8s.io/v1alpha1
- **apiVersion**: resource.k8s.io/v1alpha2
- **kind**: ResourceClaimTemplate
@ -42,7 +42,7 @@ ResourceClaimTemplate is used to produce ResourceClaim objects.
Standard object metadata
- **spec** (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha1#ResourceClaimTemplateSpec" >}}">ResourceClaimTemplateSpec</a>), required
- **spec** (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha2#ResourceClaimTemplateSpec" >}}">ResourceClaimTemplateSpec</a>), required
Describes the ResourceClaim that is to be generated.
@ -58,7 +58,7 @@ ResourceClaimTemplateSpec contains the metadata and fields for a ResourceClaim.
<hr>
- **spec** (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaimSpec" >}}">ResourceClaimSpec</a>), required
- **spec** (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaimSpec" >}}">ResourceClaimSpec</a>), required
Spec for the ResourceClaim. The entire content is copied unchanged into the ResourceClaim that gets created from this template. The same fields as in a ResourceClaim are also valid here.
@ -76,7 +76,7 @@ ResourceClaimTemplateList is a collection of claim templates.
<hr>
- **apiVersion**: resource.k8s.io/v1alpha1
- **apiVersion**: resource.k8s.io/v1alpha2
- **kind**: ResourceClaimTemplateList
@ -86,7 +86,7 @@ ResourceClaimTemplateList is a collection of claim templates.
Standard list metadata
- **items** ([]<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>), required
- **items** ([]<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>), required
Items is the list of resource claim templates.
@ -109,7 +109,7 @@ ResourceClaimTemplateList is a collection of claim templates.
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplates/{name}
GET /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates/{name}
#### Parameters
@ -133,7 +133,7 @@ GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplates
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
401: Unauthorized
@ -142,7 +142,7 @@ GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplates
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplates
GET /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates
#### Parameters
@ -192,6 +192,11 @@ GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplates
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -206,7 +211,7 @@ GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplates
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha1#ResourceClaimTemplateList" >}}">ResourceClaimTemplateList</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha2#ResourceClaimTemplateList" >}}">ResourceClaimTemplateList</a>): OK
401: Unauthorized
@ -215,7 +220,7 @@ GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplates
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha1/resourceclaimtemplates
GET /apis/resource.k8s.io/v1alpha2/resourceclaimtemplates
#### Parameters
@ -260,6 +265,11 @@ GET /apis/resource.k8s.io/v1alpha1/resourceclaimtemplates
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -274,7 +284,7 @@ GET /apis/resource.k8s.io/v1alpha1/resourceclaimtemplates
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha1#ResourceClaimTemplateList" >}}">ResourceClaimTemplateList</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha2#ResourceClaimTemplateList" >}}">ResourceClaimTemplateList</a>): OK
401: Unauthorized
@ -283,7 +293,7 @@ GET /apis/resource.k8s.io/v1alpha1/resourceclaimtemplates
#### HTTP Request
POST /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplates
POST /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates
#### Parameters
@ -293,7 +303,7 @@ POST /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplate
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/resource-claim-template-v1alpha1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>, required
- **body**: <a href="{{< ref "../workload-resources/resource-claim-template-v1alpha2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>, required
@ -322,11 +332,11 @@ POST /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplate
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
201 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Created
201 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Created
202 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Accepted
202 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Accepted
401: Unauthorized
@ -335,7 +345,7 @@ POST /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplate
#### HTTP Request
PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplates/{name}
PUT /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates/{name}
#### Parameters
@ -350,7 +360,7 @@ PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplates
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/resource-claim-template-v1alpha1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>, required
- **body**: <a href="{{< ref "../workload-resources/resource-claim-template-v1alpha2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>, required
@ -379,9 +389,9 @@ PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplates
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
201 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Created
201 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Created
401: Unauthorized
@ -390,7 +400,7 @@ PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplates
#### HTTP Request
PATCH /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplates/{name}
PATCH /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates/{name}
#### Parameters
@ -439,9 +449,9 @@ PATCH /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplat
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
201 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Created
201 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Created
401: Unauthorized
@ -450,7 +460,7 @@ PATCH /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplat
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplates/{name}
DELETE /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates/{name}
#### Parameters
@ -494,9 +504,9 @@ DELETE /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtempla
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): OK
202 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha1#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Accepted
202 (<a href="{{< ref "../workload-resources/resource-claim-template-v1alpha2#ResourceClaimTemplate" >}}">ResourceClaimTemplate</a>): Accepted
401: Unauthorized
@ -505,7 +515,7 @@ DELETE /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtempla
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtemplates
DELETE /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaimtemplates
#### Parameters
@ -570,6 +580,11 @@ DELETE /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaimtempla
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -1,11 +1,11 @@
---
api_metadata:
apiVersion: "resource.k8s.io/v1alpha1"
import: "k8s.io/api/resource/v1alpha1"
apiVersion: "resource.k8s.io/v1alpha2"
import: "k8s.io/api/resource/v1alpha2"
kind: "ResourceClaim"
content_type: "api_reference"
description: "ResourceClaim describes which resources are needed by a resource consumer."
title: "ResourceClaim v1alpha1"
title: "ResourceClaim v1alpha2"
weight: 15
auto_generated: true
---
@ -21,9 +21,9 @@ guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
`apiVersion: resource.k8s.io/v1alpha1`
`apiVersion: resource.k8s.io/v1alpha2`
`import "k8s.io/api/resource/v1alpha1"`
`import "k8s.io/api/resource/v1alpha2"`
## ResourceClaim {#ResourceClaim}
@ -34,7 +34,7 @@ This is an alpha type and requires enabling the DynamicResourceAllocation featur
<hr>
- **apiVersion**: resource.k8s.io/v1alpha1
- **apiVersion**: resource.k8s.io/v1alpha2
- **kind**: ResourceClaim
@ -44,11 +44,11 @@ This is an alpha type and requires enabling the DynamicResourceAllocation featur
Standard object metadata
- **spec** (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaimSpec" >}}">ResourceClaimSpec</a>), required
- **spec** (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaimSpec" >}}">ResourceClaimSpec</a>), required
Spec describes the desired attributes of a resource that then needs to be allocated. It can only be set once when creating the ResourceClaim.
- **status** (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaimStatus" >}}">ResourceClaimStatus</a>)
- **status** (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaimStatus" >}}">ResourceClaimStatus</a>)
Status describes whether the resource is available and with which attributes.
@ -103,14 +103,14 @@ ResourceClaimStatus tracks whether the resource has been allocated and what the
- **allocation** (AllocationResult)
Allocation is set by the resource driver once a resource has been allocated successfully. If this is not specified, the resource is not yet allocated.
Allocation is set by the resource driver once a resource or set of resources has been allocated successfully. If this is not specified, the resources have not been allocated yet.
<a name="AllocationResult"></a>
*AllocationResult contains attributed of an allocated resource.*
*AllocationResult contains attributes of an allocated resource.*
- **allocation.availableOnNodes** (NodeSelector)
This field will get set by the resource driver after it has allocated the resource driver to inform the scheduler where it can schedule Pods using the ResourceClaim.
This field will get set by the resource driver after it has allocated the resource to inform the scheduler where it can schedule Pods using the ResourceClaim.
Setting this field is optional. If null, the resource is available everywhere.
@ -132,11 +132,26 @@ ResourceClaimStatus tracks whether the resource has been allocated and what the
A list of node selector requirements by node's fields.
- **allocation.resourceHandle** (string)
- **allocation.resourceHandles** ([]ResourceHandle)
ResourceHandle contains arbitrary data returned by the driver after a successful allocation. This is opaque for Kubernetes. Driver documentation may explain to users how to interpret this data if needed.
*Atomic: will be replaced during a merge*
The maximum size of this field is 16KiB. This may get increased in the future, but not reduced.
ResourceHandles contain the state associated with an allocation that should be maintained throughout the lifetime of a claim. Each ResourceHandle contains data that should be passed to a specific kubelet plugin once it lands on a node. This data is returned by the driver after a successful allocation and is opaque to Kubernetes. Driver documentation may explain to users how to interpret this data if needed.
Setting this field is optional. It has a maximum size of 32 entries. If null (or empty), it is assumed this allocation will be processed by a single kubelet plugin with no ResourceHandle data attached. The name of the kubelet plugin invoked will match the DriverName set in the ResourceClaimStatus this AllocationResult is embedded in.
<a name="ResourceHandle"></a>
*ResourceHandle holds opaque resource data for processing by a specific kubelet plugin.*
- **allocation.resourceHandles.data** (string)
Data contains the opaque data associated with this ResourceHandle. It is set by the controller component of the resource driver whose name matches the DriverName set in the ResourceClaimStatus this ResourceHandle is embedded in. It is set at allocation time and is intended for processing by the kubelet plugin whose name matches the DriverName set in this ResourceHandle.
The maximum size of this field is 16KiB. This may get increased in the future, but not reduced.
- **allocation.resourceHandles.driverName** (string)
DriverName specifies the name of the resource driver whose kubelet plugin should be invoked to process this ResourceHandle's data once it lands on a node. This may differ from the DriverName set in ResourceClaimStatus this ResourceHandle is embedded in.
- **allocation.shareable** (boolean)
@ -156,7 +171,7 @@ ResourceClaimStatus tracks whether the resource has been allocated and what the
- **reservedFor** ([]ResourceClaimConsumerReference)
*Set: unique values will be kept during a merge*
*Map: unique values on key uid will be kept during a merge*
ReservedFor indicates which entities are currently allowed to use the claim. A Pod which references a ResourceClaim which is not reserved for that Pod will not be started.
@ -191,7 +206,7 @@ ResourceClaimList is a collection of claims.
<hr>
- **apiVersion**: resource.k8s.io/v1alpha1
- **apiVersion**: resource.k8s.io/v1alpha2
- **kind**: ResourceClaimList
@ -201,7 +216,7 @@ ResourceClaimList is a collection of claims.
Standard list metadata
- **items** ([]<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>), required
- **items** ([]<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>), required
Items is the list of resource claims.
@ -224,7 +239,7 @@ ResourceClaimList is a collection of claims.
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}
GET /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims/{name}
#### Parameters
@ -248,7 +263,7 @@ GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>): OK
401: Unauthorized
@ -257,7 +272,7 @@ GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}/status
GET /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims/{name}/status
#### Parameters
@ -281,7 +296,7 @@ GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}/
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>): OK
401: Unauthorized
@ -290,7 +305,7 @@ GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}/
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims
GET /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims
#### Parameters
@ -340,6 +355,11 @@ GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -354,7 +374,7 @@ GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaimList" >}}">ResourceClaimList</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaimList" >}}">ResourceClaimList</a>): OK
401: Unauthorized
@ -363,7 +383,7 @@ GET /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha1/resourceclaims
GET /apis/resource.k8s.io/v1alpha2/resourceclaims
#### Parameters
@ -408,6 +428,11 @@ GET /apis/resource.k8s.io/v1alpha1/resourceclaims
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -422,7 +447,7 @@ GET /apis/resource.k8s.io/v1alpha1/resourceclaims
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaimList" >}}">ResourceClaimList</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaimList" >}}">ResourceClaimList</a>): OK
401: Unauthorized
@ -431,7 +456,7 @@ GET /apis/resource.k8s.io/v1alpha1/resourceclaims
#### HTTP Request
POST /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims
POST /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims
#### Parameters
@ -441,7 +466,7 @@ POST /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>, required
- **body**: <a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>, required
@ -470,11 +495,11 @@ POST /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>): OK
201 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>): Created
201 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>): Created
202 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>): Accepted
202 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>): Accepted
401: Unauthorized
@ -483,7 +508,7 @@ POST /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims
#### HTTP Request
PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}
PUT /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims/{name}
#### Parameters
@ -498,7 +523,7 @@ PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>, required
- **body**: <a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>, required
@ -527,9 +552,9 @@ PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>): OK
201 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>): Created
201 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>): Created
401: Unauthorized
@ -538,7 +563,7 @@ PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}
#### HTTP Request
PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}/status
PUT /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims/{name}/status
#### Parameters
@ -553,7 +578,7 @@ PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}/
<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace</a>
- **body**: <a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>, required
- **body**: <a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>, required
@ -582,9 +607,9 @@ PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}/
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>): OK
201 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>): Created
201 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>): Created
401: Unauthorized
@ -593,7 +618,7 @@ PUT /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}/
#### HTTP Request
PATCH /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}
PATCH /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims/{name}
#### Parameters
@ -642,9 +667,9 @@ PATCH /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>): OK
201 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>): Created
201 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>): Created
401: Unauthorized
@ -653,7 +678,7 @@ PATCH /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name
#### HTTP Request
PATCH /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}/status
PATCH /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims/{name}/status
#### Parameters
@ -702,9 +727,9 @@ PATCH /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>): OK
201 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>): Created
201 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>): Created
401: Unauthorized
@ -713,7 +738,7 @@ PATCH /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{name}
DELETE /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims/{name}
#### Parameters
@ -757,9 +782,9 @@ DELETE /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{nam
#### Response
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>): OK
202 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha1#ResourceClaim" >}}">ResourceClaim</a>): Accepted
202 (<a href="{{< ref "../workload-resources/resource-claim-v1alpha2#ResourceClaim" >}}">ResourceClaim</a>): Accepted
401: Unauthorized
@ -768,7 +793,7 @@ DELETE /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims/{nam
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims
DELETE /apis/resource.k8s.io/v1alpha2/namespaces/{namespace}/resourceclaims
#### Parameters
@ -833,6 +858,11 @@ DELETE /apis/resource.k8s.io/v1alpha1/namespaces/{namespace}/resourceclaims
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -1,11 +1,11 @@
---
api_metadata:
apiVersion: "resource.k8s.io/v1alpha1"
import: "k8s.io/api/resource/v1alpha1"
apiVersion: "resource.k8s.io/v1alpha2"
import: "k8s.io/api/resource/v1alpha2"
kind: "ResourceClass"
content_type: "api_reference"
description: "ResourceClass is used by administrators to influence how resources are allocated."
title: "ResourceClass v1alpha1"
title: "ResourceClass v1alpha2"
weight: 17
auto_generated: true
---
@ -21,9 +21,9 @@ guide. You can file document formatting bugs against the
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
-->
`apiVersion: resource.k8s.io/v1alpha1`
`apiVersion: resource.k8s.io/v1alpha2`
`import "k8s.io/api/resource/v1alpha1"`
`import "k8s.io/api/resource/v1alpha2"`
## ResourceClass {#ResourceClass}
@ -34,7 +34,7 @@ This is an alpha type and requires enabling the DynamicResourceAllocation featur
<hr>
- **apiVersion**: resource.k8s.io/v1alpha1
- **apiVersion**: resource.k8s.io/v1alpha2
- **kind**: ResourceClass
@ -107,7 +107,7 @@ ResourceClassList is a collection of classes.
<hr>
- **apiVersion**: resource.k8s.io/v1alpha1
- **apiVersion**: resource.k8s.io/v1alpha2
- **kind**: ResourceClassList
@ -117,7 +117,7 @@ ResourceClassList is a collection of classes.
Standard list metadata
- **items** ([]<a href="{{< ref "../workload-resources/resource-class-v1alpha1#ResourceClass" >}}">ResourceClass</a>), required
- **items** ([]<a href="{{< ref "../workload-resources/resource-class-v1alpha2#ResourceClass" >}}">ResourceClass</a>), required
Items is the list of resource classes.
@ -140,7 +140,7 @@ ResourceClassList is a collection of classes.
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha1/resourceclasses/{name}
GET /apis/resource.k8s.io/v1alpha2/resourceclasses/{name}
#### Parameters
@ -159,7 +159,7 @@ GET /apis/resource.k8s.io/v1alpha1/resourceclasses/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/resource-class-v1alpha1#ResourceClass" >}}">ResourceClass</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-class-v1alpha2#ResourceClass" >}}">ResourceClass</a>): OK
401: Unauthorized
@ -168,7 +168,7 @@ GET /apis/resource.k8s.io/v1alpha1/resourceclasses/{name}
#### HTTP Request
GET /apis/resource.k8s.io/v1alpha1/resourceclasses
GET /apis/resource.k8s.io/v1alpha2/resourceclasses
#### Parameters
@ -213,6 +213,11 @@ GET /apis/resource.k8s.io/v1alpha1/resourceclasses
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -227,7 +232,7 @@ GET /apis/resource.k8s.io/v1alpha1/resourceclasses
#### Response
200 (<a href="{{< ref "../workload-resources/resource-class-v1alpha1#ResourceClassList" >}}">ResourceClassList</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-class-v1alpha2#ResourceClassList" >}}">ResourceClassList</a>): OK
401: Unauthorized
@ -236,12 +241,12 @@ GET /apis/resource.k8s.io/v1alpha1/resourceclasses
#### HTTP Request
POST /apis/resource.k8s.io/v1alpha1/resourceclasses
POST /apis/resource.k8s.io/v1alpha2/resourceclasses
#### Parameters
- **body**: <a href="{{< ref "../workload-resources/resource-class-v1alpha1#ResourceClass" >}}">ResourceClass</a>, required
- **body**: <a href="{{< ref "../workload-resources/resource-class-v1alpha2#ResourceClass" >}}">ResourceClass</a>, required
@ -270,11 +275,11 @@ POST /apis/resource.k8s.io/v1alpha1/resourceclasses
#### Response
200 (<a href="{{< ref "../workload-resources/resource-class-v1alpha1#ResourceClass" >}}">ResourceClass</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-class-v1alpha2#ResourceClass" >}}">ResourceClass</a>): OK
201 (<a href="{{< ref "../workload-resources/resource-class-v1alpha1#ResourceClass" >}}">ResourceClass</a>): Created
201 (<a href="{{< ref "../workload-resources/resource-class-v1alpha2#ResourceClass" >}}">ResourceClass</a>): Created
202 (<a href="{{< ref "../workload-resources/resource-class-v1alpha1#ResourceClass" >}}">ResourceClass</a>): Accepted
202 (<a href="{{< ref "../workload-resources/resource-class-v1alpha2#ResourceClass" >}}">ResourceClass</a>): Accepted
401: Unauthorized
@ -283,7 +288,7 @@ POST /apis/resource.k8s.io/v1alpha1/resourceclasses
#### HTTP Request
PUT /apis/resource.k8s.io/v1alpha1/resourceclasses/{name}
PUT /apis/resource.k8s.io/v1alpha2/resourceclasses/{name}
#### Parameters
@ -293,7 +298,7 @@ PUT /apis/resource.k8s.io/v1alpha1/resourceclasses/{name}
name of the ResourceClass
- **body**: <a href="{{< ref "../workload-resources/resource-class-v1alpha1#ResourceClass" >}}">ResourceClass</a>, required
- **body**: <a href="{{< ref "../workload-resources/resource-class-v1alpha2#ResourceClass" >}}">ResourceClass</a>, required
@ -322,9 +327,9 @@ PUT /apis/resource.k8s.io/v1alpha1/resourceclasses/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/resource-class-v1alpha1#ResourceClass" >}}">ResourceClass</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-class-v1alpha2#ResourceClass" >}}">ResourceClass</a>): OK
201 (<a href="{{< ref "../workload-resources/resource-class-v1alpha1#ResourceClass" >}}">ResourceClass</a>): Created
201 (<a href="{{< ref "../workload-resources/resource-class-v1alpha2#ResourceClass" >}}">ResourceClass</a>): Created
401: Unauthorized
@ -333,7 +338,7 @@ PUT /apis/resource.k8s.io/v1alpha1/resourceclasses/{name}
#### HTTP Request
PATCH /apis/resource.k8s.io/v1alpha1/resourceclasses/{name}
PATCH /apis/resource.k8s.io/v1alpha2/resourceclasses/{name}
#### Parameters
@ -377,9 +382,9 @@ PATCH /apis/resource.k8s.io/v1alpha1/resourceclasses/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/resource-class-v1alpha1#ResourceClass" >}}">ResourceClass</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-class-v1alpha2#ResourceClass" >}}">ResourceClass</a>): OK
201 (<a href="{{< ref "../workload-resources/resource-class-v1alpha1#ResourceClass" >}}">ResourceClass</a>): Created
201 (<a href="{{< ref "../workload-resources/resource-class-v1alpha2#ResourceClass" >}}">ResourceClass</a>): Created
401: Unauthorized
@ -388,7 +393,7 @@ PATCH /apis/resource.k8s.io/v1alpha1/resourceclasses/{name}
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha1/resourceclasses/{name}
DELETE /apis/resource.k8s.io/v1alpha2/resourceclasses/{name}
#### Parameters
@ -427,9 +432,9 @@ DELETE /apis/resource.k8s.io/v1alpha1/resourceclasses/{name}
#### Response
200 (<a href="{{< ref "../workload-resources/resource-class-v1alpha1#ResourceClass" >}}">ResourceClass</a>): OK
200 (<a href="{{< ref "../workload-resources/resource-class-v1alpha2#ResourceClass" >}}">ResourceClass</a>): OK
202 (<a href="{{< ref "../workload-resources/resource-class-v1alpha1#ResourceClass" >}}">ResourceClass</a>): Accepted
202 (<a href="{{< ref "../workload-resources/resource-class-v1alpha2#ResourceClass" >}}">ResourceClass</a>): Accepted
401: Unauthorized
@ -438,7 +443,7 @@ DELETE /apis/resource.k8s.io/v1alpha1/resourceclasses/{name}
#### HTTP Request
DELETE /apis/resource.k8s.io/v1alpha1/resourceclasses
DELETE /apis/resource.k8s.io/v1alpha2/resourceclasses
#### Parameters
@ -498,6 +503,11 @@ DELETE /apis/resource.k8s.io/v1alpha1/resourceclasses
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>

View File

@ -74,7 +74,7 @@ A StatefulSetSpec is the specification of a StatefulSet.
- **template** (<a href="{{< ref "../workload-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. Each pod will be named with the format \<statefulsetname>-\<podindex>. For example, a pod in a StatefulSet named "web" with index number "3" would be named "web-3".
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. Each pod will be named with the format \<statefulsetname>-\<podindex>. For example, a pod in a StatefulSet named "web" with index number "3" would be named "web-3". The only allowed template.spec.restartPolicy value is "Always".
- **replicas** (int32)
@ -90,8 +90,6 @@ A StatefulSetSpec is the specification of a StatefulSet.
- **updateStrategy.type** (string)
Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.
- **updateStrategy.rollingUpdate** (RollingUpdateStatefulSetStrategy)
@ -114,8 +112,6 @@ A StatefulSetSpec is the specification of a StatefulSet.
- **podManagementPolicy** (string)
podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
- **revisionHistoryLimit** (int32)
@ -146,7 +142,7 @@ A StatefulSetSpec is the specification of a StatefulSet.
- **ordinals** (StatefulSetOrdinals)
ordinals controls the numbering of replica indices in a StatefulSet. The default ordinals behavior assigns a "0" index to the first replica and increments the index by one for each additional replica requested. Using the ordinals field requires the StatefulSetStartOrdinal feature gate to be enabled, which is alpha.
ordinals controls the numbering of replica indices in a StatefulSet. The default ordinals behavior assigns a "0" index to the first replica and increments the index by one for each additional replica requested. Using the ordinals field requires the StatefulSetStartOrdinal feature gate to be enabled, which is beta.
<a name="StatefulSetOrdinals"></a>
*StatefulSetOrdinals describes the policy used for replica ordinal assignment in this StatefulSet.*
@ -395,6 +391,11 @@ GET /apis/apps/v1/namespaces/{namespace}/statefulsets
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -463,6 +464,11 @@ GET /apis/apps/v1/statefulsets
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
@ -888,6 +894,11 @@ DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **sendInitialEvents** (*in query*): boolean
<a href="{{< ref "../common-parameters/common-parameters#sendInitialEvents" >}}">sendInitialEvents</a>
- **timeoutSeconds** (*in query*): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>