From 320360e10a779e5db603aba72b2a8e50b24d9373 Mon Sep 17 00:00:00 2001 From: Philippe Martin Date: Wed, 6 Jan 2021 20:18:04 +0100 Subject: [PATCH] Separate resource description from list of resource fields From https://github.com/kubernetes-sigs/reference-docs/pull/190 --- .../certificate-signing-request-v1.md | 5 +++++ .../service-account-v1.md | 3 +++ .../authentication-resources/token-request-v1.md | 4 ++++ .../authentication-resources/token-review-v1.md | 4 ++++ .../cluster-role-binding-v1.md | 3 +++ .../authorization-resources/cluster-role-v1.md | 3 +++ .../local-subject-access-review-v1.md | 2 ++ .../authorization-resources/role-binding-v1.md | 3 +++ .../authorization-resources/role-v1.md | 3 +++ .../self-subject-access-review-v1.md | 3 +++ .../self-subject-rules-review-v1.md | 3 +++ .../subject-access-review-v1.md | 4 ++++ .../cluster-resources/api-service-v1.md | 5 +++++ .../cluster-resources/binding-v1.md | 2 ++ .../cluster-resources/component-status-v1.md | 3 +++ .../kubernetes-api/cluster-resources/event-v1.md | 3 +++ .../cluster-resources/flow-schema-v1beta1.md | 5 +++++ .../kubernetes-api/cluster-resources/lease-v1.md | 4 ++++ .../cluster-resources/namespace-v1.md | 5 +++++ .../kubernetes-api/cluster-resources/node-v1.md | 5 +++++ .../priority-level-configuration-v1beta1.md | 5 +++++ .../cluster-resources/runtime-class-v1.md | 3 +++ .../common-definitions/delete-options.md | 1 + .../downward-api-volume-file.md | 1 + .../common-definitions/exec-action.md | 1 + .../common-definitions/http-get-action.md | 1 + .../common-definitions/json-schema-props.md | 1 + .../common-definitions/key-to-path.md | 1 + .../common-definitions/label-selector.md | 1 + .../common-definitions/list-meta.md | 1 + .../common-definitions/local-object-reference.md | 1 + .../common-definitions/node-affinity.md | 1 + .../node-selector-requirement.md | 1 + .../common-definitions/object-field-selector.md | 1 + .../common-definitions/object-meta.md | 1 + .../common-definitions/object-reference.md | 1 + .../kubernetes-api/common-definitions/patch.md | 1 + .../common-definitions/pod-affinity.md | 1 + .../common-definitions/pod-anti-affinity.md | 1 + .../common-definitions/quantity.md | 1 + .../resource-field-selector.md | 1 + .../kubernetes-api/common-definitions/status.md | 1 + .../common-definitions/tcp-socket-action.md | 1 + .../typed-local-object-reference.md | 1 + .../common-parameters/common-parameters.md | 16 ++++++++++++++++ .../config-map-v1.md | 3 +++ .../csi-driver-v1.md | 4 ++++ .../config-and-storage-resources/csi-node-v1.md | 4 ++++ .../persistent-volume-claim-v1.md | 5 +++++ .../persistent-volume-v1.md | 5 +++++ .../config-and-storage-resources/secret-v1.md | 3 +++ .../storage-class-v1.md | 3 +++ .../volume-attachment-v1.md | 5 +++++ .../config-and-storage-resources/volume.md | 1 + .../custom-resource-definition-v1.md | 5 +++++ .../mutating-webhook-configuration-v1.md | 3 +++ .../validating-webhook-configuration-v1.md | 3 +++ .../policies-resources/limit-range-v1.md | 4 ++++ .../policies-resources/network-policy-v1.md | 4 ++++ .../pod-disruption-budget-v1beta1.md | 5 +++++ .../pod-security-policy-v1beta1.md | 4 ++++ .../policies-resources/resource-quota-v1.md | 5 +++++ .../services-resources/endpoint-slice-v1beta1.md | 3 +++ .../services-resources/endpoints-v1.md | 3 +++ .../services-resources/ingress-class-v1.md | 4 ++++ .../services-resources/ingress-v1.md | 5 +++++ .../services-resources/service-v1.md | 5 +++++ .../workloads-resources/container.md | 2 ++ .../controller-revision-v1.md | 3 +++ .../workloads-resources/cron-job-v1beta1.md | 5 +++++ .../workloads-resources/cron-job-v2alpha1.md | 5 +++++ .../workloads-resources/daemon-set-v1.md | 5 +++++ .../workloads-resources/deployment-v1.md | 5 +++++ .../workloads-resources/ephemeral-container.md | 1 + .../horizontal-pod-autoscaler-v1.md | 5 +++++ .../horizontal-pod-autoscaler-v2beta2.md | 5 +++++ .../kubernetes-api/workloads-resources/job-v1.md | 5 +++++ .../workloads-resources/pod-template-v1.md | 4 ++++ .../kubernetes-api/workloads-resources/pod-v1.md | 5 +++++ .../workloads-resources/priority-class-v1.md | 3 +++ .../workloads-resources/replica-set-v1.md | 5 +++++ .../replication-controller-v1.md | 5 +++++ .../workloads-resources/stateful-set-v1.md | 5 +++++ 83 files changed, 272 insertions(+) diff --git a/content/en/docs/reference/kubernetes-api/authentication-resources/certificate-signing-request-v1.md b/content/en/docs/reference/kubernetes-api/authentication-resources/certificate-signing-request-v1.md index ea2c7b0037a82..c6a0d34757f8e 100644 --- a/content/en/docs/reference/kubernetes-api/authentication-resources/certificate-signing-request-v1.md +++ b/content/en/docs/reference/kubernetes-api/authentication-resources/certificate-signing-request-v1.md @@ -24,6 +24,7 @@ Kubelets use this API to obtain: This API can be used to request client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client" signerName), or to obtain certificates from custom non-Kubernetes signers. +
- **apiVersion**: certificates.k8s.io/v1 @@ -50,6 +51,7 @@ This API can be used to request client certificates to authenticate to kube-apis CertificateSigningRequestSpec contains the certificate request. +
- **request** ([]byte), required @@ -126,6 +128,7 @@ CertificateSigningRequestSpec contains the certificate request. CertificateSigningRequestStatus contains conditions used to indicate approved/denied/failed status of the request, and the issued certificate. +
- **certificate** ([]byte) @@ -211,6 +214,7 @@ CertificateSigningRequestStatus contains conditions used to indicate approved/de CertificateSigningRequestList is a collection of CertificateSigningRequest objects +
- **apiVersion**: certificates.k8s.io/v1 @@ -233,6 +237,7 @@ CertificateSigningRequestList is a collection of CertificateSigningRequest objec +
diff --git a/content/en/docs/reference/kubernetes-api/authentication-resources/service-account-v1.md b/content/en/docs/reference/kubernetes-api/authentication-resources/service-account-v1.md index 7f7a5f2a4b94f..8e202ad28d6f6 100644 --- a/content/en/docs/reference/kubernetes-api/authentication-resources/service-account-v1.md +++ b/content/en/docs/reference/kubernetes-api/authentication-resources/service-account-v1.md @@ -18,6 +18,7 @@ weight: 1 ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets +
- **apiVersion**: v1 @@ -51,6 +52,7 @@ ServiceAccount binds together: * a name, understood by users, and perhaps by per ServiceAccountList is a list of ServiceAccount objects +
- **apiVersion**: v1 @@ -74,6 +76,7 @@ ServiceAccountList is a list of ServiceAccount objects +
diff --git a/content/en/docs/reference/kubernetes-api/authentication-resources/token-request-v1.md b/content/en/docs/reference/kubernetes-api/authentication-resources/token-request-v1.md index 9ba2519366d4f..c0ddd62af309f 100644 --- a/content/en/docs/reference/kubernetes-api/authentication-resources/token-request-v1.md +++ b/content/en/docs/reference/kubernetes-api/authentication-resources/token-request-v1.md @@ -18,6 +18,7 @@ weight: 2 TokenRequest requests a token for a given service account. +
- **apiVersion**: authentication.k8s.io/v1 @@ -42,6 +43,7 @@ TokenRequest requests a token for a given service account. TokenRequestSpec contains client provided parameters of a token request. +
- **audiences** ([]string), required @@ -82,6 +84,7 @@ TokenRequestSpec contains client provided parameters of a token request. TokenRequestStatus is the result of a token request. +
- **expirationTimestamp** (Time), required @@ -102,6 +105,7 @@ TokenRequestStatus is the result of a token request. +
diff --git a/content/en/docs/reference/kubernetes-api/authentication-resources/token-review-v1.md b/content/en/docs/reference/kubernetes-api/authentication-resources/token-review-v1.md index a35a085beb4cd..06e0ffd5cd19b 100644 --- a/content/en/docs/reference/kubernetes-api/authentication-resources/token-review-v1.md +++ b/content/en/docs/reference/kubernetes-api/authentication-resources/token-review-v1.md @@ -18,6 +18,7 @@ weight: 3 TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver. +
- **apiVersion**: authentication.k8s.io/v1 @@ -44,6 +45,7 @@ TokenReview attempts to authenticate a token to a known user. Note: TokenReview TokenReviewSpec is a description of the token authentication request. +
- **audiences** ([]string) @@ -61,6 +63,7 @@ TokenReviewSpec is a description of the token authentication request. TokenReviewStatus is the result of the token authentication request. +
- **audiences** ([]string) @@ -105,6 +108,7 @@ TokenReviewStatus is the result of the token authentication request. +
diff --git a/content/en/docs/reference/kubernetes-api/authorization-resources/cluster-role-binding-v1.md b/content/en/docs/reference/kubernetes-api/authorization-resources/cluster-role-binding-v1.md index fa594249e318d..d7dfea2179920 100644 --- a/content/en/docs/reference/kubernetes-api/authorization-resources/cluster-role-binding-v1.md +++ b/content/en/docs/reference/kubernetes-api/authorization-resources/cluster-role-binding-v1.md @@ -18,6 +18,7 @@ weight: 6 ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. +
- **apiVersion**: rbac.authorization.k8s.io/v1 @@ -79,6 +80,7 @@ ClusterRoleBinding references a ClusterRole, but not contain it. It can referen ClusterRoleBindingList is a collection of ClusterRoleBindings +
- **apiVersion**: rbac.authorization.k8s.io/v1 @@ -102,6 +104,7 @@ ClusterRoleBindingList is a collection of ClusterRoleBindings +
diff --git a/content/en/docs/reference/kubernetes-api/authorization-resources/cluster-role-v1.md b/content/en/docs/reference/kubernetes-api/authorization-resources/cluster-role-v1.md index 6ec27f0f19d3e..34bb8099ef771 100644 --- a/content/en/docs/reference/kubernetes-api/authorization-resources/cluster-role-v1.md +++ b/content/en/docs/reference/kubernetes-api/authorization-resources/cluster-role-v1.md @@ -18,6 +18,7 @@ weight: 5 ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. +
- **apiVersion**: rbac.authorization.k8s.io/v1 @@ -75,6 +76,7 @@ ClusterRole is a cluster level, logical grouping of PolicyRules that can be refe ClusterRoleList is a collection of ClusterRoles +
- **apiVersion**: rbac.authorization.k8s.io/v1 @@ -98,6 +100,7 @@ ClusterRoleList is a collection of ClusterRoles +
diff --git a/content/en/docs/reference/kubernetes-api/authorization-resources/local-subject-access-review-v1.md b/content/en/docs/reference/kubernetes-api/authorization-resources/local-subject-access-review-v1.md index 4fb9990e2046f..144dfe257b4a4 100644 --- a/content/en/docs/reference/kubernetes-api/authorization-resources/local-subject-access-review-v1.md +++ b/content/en/docs/reference/kubernetes-api/authorization-resources/local-subject-access-review-v1.md @@ -18,6 +18,7 @@ weight: 1 LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking. +
- **apiVersion**: authorization.k8s.io/v1 @@ -44,6 +45,7 @@ LocalSubjectAccessReview checks whether or not a user or group can perform an ac +
diff --git a/content/en/docs/reference/kubernetes-api/authorization-resources/role-binding-v1.md b/content/en/docs/reference/kubernetes-api/authorization-resources/role-binding-v1.md index 9d6255733b893..36b5ebc4d6a95 100644 --- a/content/en/docs/reference/kubernetes-api/authorization-resources/role-binding-v1.md +++ b/content/en/docs/reference/kubernetes-api/authorization-resources/role-binding-v1.md @@ -18,6 +18,7 @@ weight: 8 RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. +
- **apiVersion**: rbac.authorization.k8s.io/v1 @@ -79,6 +80,7 @@ RoleBinding references a role, but does not contain it. It can reference a Role RoleBindingList is a collection of RoleBindings +
- **apiVersion**: rbac.authorization.k8s.io/v1 @@ -102,6 +104,7 @@ RoleBindingList is a collection of RoleBindings +
diff --git a/content/en/docs/reference/kubernetes-api/authorization-resources/role-v1.md b/content/en/docs/reference/kubernetes-api/authorization-resources/role-v1.md index 6e6270d6bc161..f87d305247963 100644 --- a/content/en/docs/reference/kubernetes-api/authorization-resources/role-v1.md +++ b/content/en/docs/reference/kubernetes-api/authorization-resources/role-v1.md @@ -18,6 +18,7 @@ weight: 7 Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. +
- **apiVersion**: rbac.authorization.k8s.io/v1 @@ -64,6 +65,7 @@ Role is a namespaced, logical grouping of PolicyRules that can be referenced as RoleList is a collection of Roles +
- **apiVersion**: rbac.authorization.k8s.io/v1 @@ -87,6 +89,7 @@ RoleList is a collection of Roles +
diff --git a/content/en/docs/reference/kubernetes-api/authorization-resources/self-subject-access-review-v1.md b/content/en/docs/reference/kubernetes-api/authorization-resources/self-subject-access-review-v1.md index a23f360d13a18..aacafd39b114d 100644 --- a/content/en/docs/reference/kubernetes-api/authorization-resources/self-subject-access-review-v1.md +++ b/content/en/docs/reference/kubernetes-api/authorization-resources/self-subject-access-review-v1.md @@ -18,6 +18,7 @@ weight: 2 SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action +
- **apiVersion**: authorization.k8s.io/v1 @@ -44,6 +45,7 @@ SelfSubjectAccessReview checks whether or the current user can perform an action SelfSubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set +
- **nonResourceAttributes** (NonResourceAttributes) @@ -103,6 +105,7 @@ SelfSubjectAccessReviewSpec is a description of the access request. Exactly one +
diff --git a/content/en/docs/reference/kubernetes-api/authorization-resources/self-subject-rules-review-v1.md b/content/en/docs/reference/kubernetes-api/authorization-resources/self-subject-rules-review-v1.md index f560696b3efbb..aa3d95332beb2 100644 --- a/content/en/docs/reference/kubernetes-api/authorization-resources/self-subject-rules-review-v1.md +++ b/content/en/docs/reference/kubernetes-api/authorization-resources/self-subject-rules-review-v1.md @@ -18,6 +18,7 @@ weight: 3 SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server. +
- **apiVersion**: authorization.k8s.io/v1 @@ -94,6 +95,7 @@ SelfSubjectRulesReview enumerates the set of actions the current user can perfor +
- **namespace** (string) @@ -107,6 +109,7 @@ SelfSubjectRulesReview enumerates the set of actions the current user can perfor +
diff --git a/content/en/docs/reference/kubernetes-api/authorization-resources/subject-access-review-v1.md b/content/en/docs/reference/kubernetes-api/authorization-resources/subject-access-review-v1.md index 106e6196c6226..5385b125e162d 100644 --- a/content/en/docs/reference/kubernetes-api/authorization-resources/subject-access-review-v1.md +++ b/content/en/docs/reference/kubernetes-api/authorization-resources/subject-access-review-v1.md @@ -18,6 +18,7 @@ weight: 4 SubjectAccessReview checks whether or not a user or group can perform an action. +
- **apiVersion**: authorization.k8s.io/v1 @@ -44,6 +45,7 @@ SubjectAccessReview checks whether or not a user or group can perform an action. SubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set +
- **extra** (map[string][]string) @@ -119,6 +121,7 @@ SubjectAccessReviewSpec is a description of the access request. Exactly one of SubjectAccessReviewStatus +
- **allowed** (boolean), required @@ -144,6 +147,7 @@ SubjectAccessReviewStatus +
diff --git a/content/en/docs/reference/kubernetes-api/cluster-resources/api-service-v1.md b/content/en/docs/reference/kubernetes-api/cluster-resources/api-service-v1.md index 1b0f784e1f1a5..19ed5e0eb09fd 100644 --- a/content/en/docs/reference/kubernetes-api/cluster-resources/api-service-v1.md +++ b/content/en/docs/reference/kubernetes-api/cluster-resources/api-service-v1.md @@ -18,6 +18,7 @@ weight: 4 APIService represents a server for a particular GroupVersion. Name must be "version.group". +
- **apiVersion**: apiregistration.k8s.io/v1 @@ -44,6 +45,7 @@ APIService represents a server for a particular GroupVersion. Name must be "vers APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification. +
- **groupPriorityMinimum** (int32), required @@ -98,6 +100,7 @@ APIServiceSpec contains information for locating and communicating with a server APIServiceStatus contains derived information about an API server +
- **conditions** ([]APIServiceCondition) @@ -141,6 +144,7 @@ APIServiceStatus contains derived information about an API server APIServiceList is a list of APIService objects. +
- **apiVersion**: apiregistration.k8s.io/v1 @@ -162,6 +166,7 @@ APIServiceList is a list of APIService objects. +
diff --git a/content/en/docs/reference/kubernetes-api/cluster-resources/binding-v1.md b/content/en/docs/reference/kubernetes-api/cluster-resources/binding-v1.md index d3141d6eac9c2..a007116367908 100644 --- a/content/en/docs/reference/kubernetes-api/cluster-resources/binding-v1.md +++ b/content/en/docs/reference/kubernetes-api/cluster-resources/binding-v1.md @@ -18,6 +18,7 @@ weight: 9 Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead. +
- **apiVersion**: v1 @@ -41,6 +42,7 @@ Binding ties one object to another; for example, a pod is bound to a node by a s +
diff --git a/content/en/docs/reference/kubernetes-api/cluster-resources/component-status-v1.md b/content/en/docs/reference/kubernetes-api/cluster-resources/component-status-v1.md index 74d338988f66b..3b526675502b9 100644 --- a/content/en/docs/reference/kubernetes-api/cluster-resources/component-status-v1.md +++ b/content/en/docs/reference/kubernetes-api/cluster-resources/component-status-v1.md @@ -18,6 +18,7 @@ weight: 10 ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+ +
- **apiVersion**: v1 @@ -62,6 +63,7 @@ ComponentStatus (and ComponentStatusList) holds the cluster validation info. Dep Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+ +
- **apiVersion**: v1 @@ -85,6 +87,7 @@ Status of all the conditions for the component as a list of ComponentStatus obje +
diff --git a/content/en/docs/reference/kubernetes-api/cluster-resources/event-v1.md b/content/en/docs/reference/kubernetes-api/cluster-resources/event-v1.md index fa258b303436b..065cf5a7e7faa 100644 --- a/content/en/docs/reference/kubernetes-api/cluster-resources/event-v1.md +++ b/content/en/docs/reference/kubernetes-api/cluster-resources/event-v1.md @@ -18,6 +18,7 @@ weight: 3 Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data. +
- **apiVersion**: events.k8s.io/v1 @@ -126,6 +127,7 @@ Event is a report of an event somewhere in the cluster. It generally denotes som EventList is a list of Event objects. +
- **apiVersion**: events.k8s.io/v1 @@ -149,6 +151,7 @@ EventList is a list of Event objects. +
diff --git a/content/en/docs/reference/kubernetes-api/cluster-resources/flow-schema-v1beta1.md b/content/en/docs/reference/kubernetes-api/cluster-resources/flow-schema-v1beta1.md index 7b0f16aeb6598..8f94555ee2759 100644 --- a/content/en/docs/reference/kubernetes-api/cluster-resources/flow-schema-v1beta1.md +++ b/content/en/docs/reference/kubernetes-api/cluster-resources/flow-schema-v1beta1.md @@ -18,6 +18,7 @@ weight: 7 FlowSchema defines the schema of a group of flows. Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a "flow distinguisher". +
- **apiVersion**: flowcontrol.apiserver.k8s.io/v1beta1 @@ -45,6 +46,7 @@ FlowSchema defines the schema of a group of flows. Note that a flow is made up o FlowSchemaSpec describes how the FlowSchema's specification looks like. +
- **priorityLevelConfiguration** (PriorityLevelConfigurationReference), required @@ -200,6 +202,7 @@ FlowSchemaSpec describes how the FlowSchema's specification looks like. FlowSchemaStatus represents the current state of a FlowSchema. +
- **conditions** ([]FlowSchemaCondition) @@ -241,6 +244,7 @@ FlowSchemaStatus represents the current state of a FlowSchema. FlowSchemaList is a list of FlowSchema objects. +
- **apiVersion**: flowcontrol.apiserver.k8s.io/v1beta1 @@ -264,6 +268,7 @@ FlowSchemaList is a list of FlowSchema objects. +
diff --git a/content/en/docs/reference/kubernetes-api/cluster-resources/lease-v1.md b/content/en/docs/reference/kubernetes-api/cluster-resources/lease-v1.md index 87a241f0950d8..478bc2a8e75aa 100644 --- a/content/en/docs/reference/kubernetes-api/cluster-resources/lease-v1.md +++ b/content/en/docs/reference/kubernetes-api/cluster-resources/lease-v1.md @@ -18,6 +18,7 @@ weight: 5 Lease defines a lease concept. +
- **apiVersion**: coordination.k8s.io/v1 @@ -41,6 +42,7 @@ Lease defines a lease concept. LeaseSpec is a specification of a Lease. +
- **acquireTime** (MicroTime) @@ -76,6 +78,7 @@ LeaseSpec is a specification of a Lease. LeaseList is a list of Lease objects. +
- **apiVersion**: coordination.k8s.io/v1 @@ -99,6 +102,7 @@ LeaseList is a list of Lease objects. +
diff --git a/content/en/docs/reference/kubernetes-api/cluster-resources/namespace-v1.md b/content/en/docs/reference/kubernetes-api/cluster-resources/namespace-v1.md index ba70bd749f10b..caa39a5856efc 100644 --- a/content/en/docs/reference/kubernetes-api/cluster-resources/namespace-v1.md +++ b/content/en/docs/reference/kubernetes-api/cluster-resources/namespace-v1.md @@ -18,6 +18,7 @@ weight: 2 Namespace provides a scope for Names. Use of multiple namespaces is optional. +
- **apiVersion**: v1 @@ -45,6 +46,7 @@ Namespace provides a scope for Names. Use of multiple namespaces is optional. NamespaceSpec describes the attributes on a Namespace. +
- **finalizers** ([]string) @@ -58,6 +60,7 @@ NamespaceSpec describes the attributes on a Namespace. NamespaceStatus is information about the current status of a Namespace. +
- **conditions** ([]NamespaceCondition) @@ -100,6 +103,7 @@ NamespaceStatus is information about the current status of a Namespace. NamespaceList is a list of Namespaces. +
- **apiVersion**: v1 @@ -123,6 +127,7 @@ NamespaceList is a list of Namespaces. +
diff --git a/content/en/docs/reference/kubernetes-api/cluster-resources/node-v1.md b/content/en/docs/reference/kubernetes-api/cluster-resources/node-v1.md index 0b5c2c9f7de7a..a5e796904f373 100644 --- a/content/en/docs/reference/kubernetes-api/cluster-resources/node-v1.md +++ b/content/en/docs/reference/kubernetes-api/cluster-resources/node-v1.md @@ -18,6 +18,7 @@ weight: 1 Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd). +
- **apiVersion**: v1 @@ -45,6 +46,7 @@ Node is a worker node in Kubernetes. Each node will have a unique identifier in NodeSpec describes the attributes that a node is created with. +
- **configSource** (NodeConfigSource) @@ -134,6 +136,7 @@ NodeSpec describes the attributes that a node is created with. NodeStatus is information about the current status of a node. +
- **addresses** ([]NodeAddress) @@ -423,6 +426,7 @@ NodeStatus is information about the current status of a node. NodeList is the whole list of all Nodes which have been registered with master. +
- **apiVersion**: v1 @@ -446,6 +450,7 @@ NodeList is the whole list of all Nodes which have been registered with master. +
diff --git a/content/en/docs/reference/kubernetes-api/cluster-resources/priority-level-configuration-v1beta1.md b/content/en/docs/reference/kubernetes-api/cluster-resources/priority-level-configuration-v1beta1.md index 4c4617ecab097..f5776972a0575 100644 --- a/content/en/docs/reference/kubernetes-api/cluster-resources/priority-level-configuration-v1beta1.md +++ b/content/en/docs/reference/kubernetes-api/cluster-resources/priority-level-configuration-v1beta1.md @@ -18,6 +18,7 @@ weight: 8 PriorityLevelConfiguration represents the configuration of a priority level. +
- **apiVersion**: flowcontrol.apiserver.k8s.io/v1beta1 @@ -45,6 +46,7 @@ PriorityLevelConfiguration represents the configuration of a priority level. PriorityLevelConfigurationSpec specifies the configuration of a priority level. +
- **type** (string), required @@ -105,6 +107,7 @@ PriorityLevelConfigurationSpec specifies the configuration of a priority level. PriorityLevelConfigurationStatus represents the current state of a "request-priority". +
- **conditions** ([]PriorityLevelConfigurationCondition) @@ -146,6 +149,7 @@ PriorityLevelConfigurationStatus represents the current state of a "request-prio PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects. +
- **apiVersion**: flowcontrol.apiserver.k8s.io/v1beta1 @@ -169,6 +173,7 @@ PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects. +
diff --git a/content/en/docs/reference/kubernetes-api/cluster-resources/runtime-class-v1.md b/content/en/docs/reference/kubernetes-api/cluster-resources/runtime-class-v1.md index ab27f7c087cd5..040c894ae3a4e 100644 --- a/content/en/docs/reference/kubernetes-api/cluster-resources/runtime-class-v1.md +++ b/content/en/docs/reference/kubernetes-api/cluster-resources/runtime-class-v1.md @@ -18,6 +18,7 @@ weight: 6 RuntimeClass defines a class of container runtime supported in the cluster. The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://kubernetes.io/docs/concepts/containers/runtime-class/ +
- **apiVersion**: node.k8s.io/v1 @@ -94,6 +95,7 @@ RuntimeClass defines a class of container runtime supported in the cluster. The RuntimeClassList is a list of RuntimeClass objects. +
- **apiVersion**: node.k8s.io/v1 @@ -117,6 +119,7 @@ RuntimeClassList is a list of RuntimeClass objects. +
diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/delete-options.md b/content/en/docs/reference/kubernetes-api/common-definitions/delete-options.md index 6c19a6b489d15..09fd2ce3d130a 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/delete-options.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/delete-options.md @@ -16,6 +16,7 @@ weight: 1 DeleteOptions may be provided when deleting an API object. +
- **apiVersion** (string) diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/downward-api-volume-file.md b/content/en/docs/reference/kubernetes-api/common-definitions/downward-api-volume-file.md index 7e3c3de51840c..5aa9f29822286 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/downward-api-volume-file.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/downward-api-volume-file.md @@ -16,6 +16,7 @@ weight: 2 DownwardAPIVolumeFile represents information to create the file containing the pod field +
- **path** (string), required diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/exec-action.md b/content/en/docs/reference/kubernetes-api/common-definitions/exec-action.md index 4577088c5379f..0078859720175 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/exec-action.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/exec-action.md @@ -16,6 +16,7 @@ weight: 3 ExecAction describes a "run in container" action. +
- **command** ([]string) diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/http-get-action.md b/content/en/docs/reference/kubernetes-api/common-definitions/http-get-action.md index 6a5025c2f9083..1eabe9ac2d579 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/http-get-action.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/http-get-action.md @@ -16,6 +16,7 @@ weight: 4 HTTPGetAction describes an action based on HTTP Get requests. +
- **port** (IntOrString), required diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/json-schema-props.md b/content/en/docs/reference/kubernetes-api/common-definitions/json-schema-props.md index fd0700fc4e4fb..622dba69a2712 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/json-schema-props.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/json-schema-props.md @@ -16,6 +16,7 @@ weight: 5 JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/). +
- **$ref** (string) diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/key-to-path.md b/content/en/docs/reference/kubernetes-api/common-definitions/key-to-path.md index 4632af676d9ca..64068fe1a2710 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/key-to-path.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/key-to-path.md @@ -16,6 +16,7 @@ weight: 6 Maps a string key to a path within a volume. +
- **key** (string), required diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/label-selector.md b/content/en/docs/reference/kubernetes-api/common-definitions/label-selector.md index 1562f079979db..a588677077a64 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/label-selector.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/label-selector.md @@ -16,6 +16,7 @@ weight: 7 A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. +
- **matchExpressions** ([]LabelSelectorRequirement) diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/list-meta.md b/content/en/docs/reference/kubernetes-api/common-definitions/list-meta.md index d6917c667cffa..0b703734b0ba6 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/list-meta.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/list-meta.md @@ -16,6 +16,7 @@ weight: 8 ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. +
- **continue** (string) diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/local-object-reference.md b/content/en/docs/reference/kubernetes-api/common-definitions/local-object-reference.md index f37aca8092963..e97b84aca9e39 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/local-object-reference.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/local-object-reference.md @@ -16,6 +16,7 @@ weight: 9 LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +
- **name** (string) diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/node-affinity.md b/content/en/docs/reference/kubernetes-api/common-definitions/node-affinity.md index ea543deb71d61..57b0b627159af 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/node-affinity.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/node-affinity.md @@ -16,6 +16,7 @@ weight: 10 Node affinity is a group of node affinity scheduling rules. +
- **preferredDuringSchedulingIgnoredDuringExecution** ([]PreferredSchedulingTerm) diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/node-selector-requirement.md b/content/en/docs/reference/kubernetes-api/common-definitions/node-selector-requirement.md index e83c4f72b2a81..3e8b935ef7f3c 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/node-selector-requirement.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/node-selector-requirement.md @@ -16,6 +16,7 @@ weight: 11 A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. +
- **key** (string), required diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/object-field-selector.md b/content/en/docs/reference/kubernetes-api/common-definitions/object-field-selector.md index 62f7b9634c5ac..c109fa3fdf89e 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/object-field-selector.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/object-field-selector.md @@ -16,6 +16,7 @@ weight: 12 ObjectFieldSelector selects an APIVersioned field of an object. +
- **fieldPath** (string), required diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/object-meta.md b/content/en/docs/reference/kubernetes-api/common-definitions/object-meta.md index 52381868feaf0..b3bc31e716113 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/object-meta.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/object-meta.md @@ -16,6 +16,7 @@ weight: 13 ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. +
- **name** (string) diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/object-reference.md b/content/en/docs/reference/kubernetes-api/common-definitions/object-reference.md index cd3c8a7837157..71c40a0702d1b 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/object-reference.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/object-reference.md @@ -16,6 +16,7 @@ weight: 14 ObjectReference contains enough information to let you inspect or modify the referred object. +
- **apiVersion** (string) diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/patch.md b/content/en/docs/reference/kubernetes-api/common-definitions/patch.md index 6b2ad9ca29f18..054508e8078e7 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/patch.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/patch.md @@ -16,6 +16,7 @@ weight: 15 Patch is provided to give a concrete name and type to the Kubernetes PATCH request body. +
diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/pod-affinity.md b/content/en/docs/reference/kubernetes-api/common-definitions/pod-affinity.md index 46d0fde7764c3..06291de393133 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/pod-affinity.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/pod-affinity.md @@ -16,6 +16,7 @@ weight: 16 Pod affinity is a group of inter pod affinity scheduling rules. +
- **preferredDuringSchedulingIgnoredDuringExecution** ([]WeightedPodAffinityTerm) diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/pod-anti-affinity.md b/content/en/docs/reference/kubernetes-api/common-definitions/pod-anti-affinity.md index 8371321abb231..baebcc3c0c17d 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/pod-anti-affinity.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/pod-anti-affinity.md @@ -16,6 +16,7 @@ weight: 17 Pod anti affinity is a group of inter pod anti affinity scheduling rules. +
- **preferredDuringSchedulingIgnoredDuringExecution** ([]WeightedPodAffinityTerm) diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/quantity.md b/content/en/docs/reference/kubernetes-api/common-definitions/quantity.md index 00568d4c634c4..c049cd40e4fe4 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/quantity.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/quantity.md @@ -46,6 +46,7 @@ Non-canonical values will still parse as long as they are well formed, but will This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. +
diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/resource-field-selector.md b/content/en/docs/reference/kubernetes-api/common-definitions/resource-field-selector.md index 759518ac7df00..85e7a9a8146e3 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/resource-field-selector.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/resource-field-selector.md @@ -16,6 +16,7 @@ weight: 19 ResourceFieldSelector represents container resources (cpu, memory) and their output format +
- **resource** (string), required diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/status.md b/content/en/docs/reference/kubernetes-api/common-definitions/status.md index 80b6b53f53a08..634e5068fb7d0 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/status.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/status.md @@ -16,6 +16,7 @@ weight: 20 Status is a return value for calls that don't return other objects. +
- **apiVersion** (string) diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/tcp-socket-action.md b/content/en/docs/reference/kubernetes-api/common-definitions/tcp-socket-action.md index afe1fc1d8ab8c..991518a57a741 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/tcp-socket-action.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/tcp-socket-action.md @@ -16,6 +16,7 @@ weight: 21 TCPSocketAction describes an action based on opening a socket +
- **port** (IntOrString), required diff --git a/content/en/docs/reference/kubernetes-api/common-definitions/typed-local-object-reference.md b/content/en/docs/reference/kubernetes-api/common-definitions/typed-local-object-reference.md index 5050a6e0a46a3..c03c3c8409b74 100644 --- a/content/en/docs/reference/kubernetes-api/common-definitions/typed-local-object-reference.md +++ b/content/en/docs/reference/kubernetes-api/common-definitions/typed-local-object-reference.md @@ -16,6 +16,7 @@ weight: 22 TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. +
- **kind** (string), required diff --git a/content/en/docs/reference/kubernetes-api/common-parameters/common-parameters.md b/content/en/docs/reference/kubernetes-api/common-parameters/common-parameters.md index cb4dc12e886f7..12792cbd08a60 100644 --- a/content/en/docs/reference/kubernetes-api/common-parameters/common-parameters.md +++ b/content/en/docs/reference/kubernetes-api/common-parameters/common-parameters.md @@ -18,6 +18,7 @@ weight: 10 allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. +
@@ -29,6 +30,7 @@ The continue option should be set when retrieving more results from the server. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. +
@@ -38,6 +40,7 @@ This field is not supported when watch is true. Clients may start a watch from t When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed +
@@ -47,6 +50,7 @@ When present, indicates that modifications should not be persisted. An invalid o fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. +
@@ -56,6 +60,7 @@ fieldManager is a name associated with the actor or entity that is making these A selector to restrict the list of returned objects by their fields. Defaults to everything. +
@@ -65,6 +70,7 @@ A selector to restrict the list of returned objects by their fields. Defaults to Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. +
@@ -74,6 +80,7 @@ Force is going to "force" Apply requests. It means user will re-acquire conflict The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. +
@@ -83,6 +90,7 @@ The duration in seconds before the object should be deleted. Value must be non-n A selector to restrict the list of returned objects by their labels. Defaults to everything. +
@@ -94,6 +102,7 @@ limit is a maximum number of responses to return for a list call. If more items The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. +
@@ -103,6 +112,7 @@ The server guarantees that the objects returned when using continue will be iden object name and auth scope, such as for teams and projects +
@@ -112,6 +122,7 @@ object name and auth scope, such as for teams and projects If 'true', then the output is pretty printed. +
@@ -121,6 +132,7 @@ If 'true', then the output is pretty printed. Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. +
@@ -132,6 +144,7 @@ resourceVersion sets a constraint on what resource versions a request may be ser Defaults to unset +
@@ -143,6 +156,7 @@ resourceVersionMatch determines how resourceVersion is applied to list calls. It Defaults to unset +
@@ -152,6 +166,7 @@ Defaults to unset Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. +
@@ -161,6 +176,7 @@ Timeout for the list/watch call. This limits the duration of the call, regardles Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. +
diff --git a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/config-map-v1.md b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/config-map-v1.md index fe870e65bc44d..b543e6c9acd57 100644 --- a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/config-map-v1.md +++ b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/config-map-v1.md @@ -18,6 +18,7 @@ weight: 1 ConfigMap holds configuration data for pods to consume. +
- **apiVersion**: v1 @@ -49,6 +50,7 @@ ConfigMap holds configuration data for pods to consume. ConfigMapList is a resource containing a list of ConfigMap objects. +
- **apiVersion**: v1 @@ -72,6 +74,7 @@ ConfigMapList is a resource containing a list of ConfigMap objects. +
diff --git a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/csi-driver-v1.md b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/csi-driver-v1.md index 1c959f539265e..b1c634b6b2115 100644 --- a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/csi-driver-v1.md +++ b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/csi-driver-v1.md @@ -18,6 +18,7 @@ weight: 8 CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced. +
- **apiVersion**: storage.k8s.io/v1 @@ -41,6 +42,7 @@ CSIDriver captures information about a Container Storage Interface (CSI) volume CSIDriverSpec is the specification of a CSIDriver. +
- **attachRequired** (boolean) @@ -116,6 +118,7 @@ CSIDriverSpec is the specification of a CSIDriver. CSIDriverList is a collection of CSIDriver objects. +
- **apiVersion**: storage.k8s.io/v1 @@ -139,6 +142,7 @@ CSIDriverList is a collection of CSIDriver objects. +
diff --git a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/csi-node-v1.md b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/csi-node-v1.md index 729f7ab7891c0..aaee041979232 100644 --- a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/csi-node-v1.md +++ b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/csi-node-v1.md @@ -18,6 +18,7 @@ weight: 9 CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object. +
- **apiVersion**: storage.k8s.io/v1 @@ -41,6 +42,7 @@ CSINode holds information about all CSI drivers installed on a node. CSI drivers CSINodeSpec holds information about the specification of all CSI drivers installed on a node +
- **drivers** ([]CSINodeDriver), required @@ -82,6 +84,7 @@ CSINodeSpec holds information about the specification of all CSI drivers install CSINodeList is a collection of CSINode objects. +
- **apiVersion**: storage.k8s.io/v1 @@ -105,6 +108,7 @@ CSINodeList is a collection of CSINode objects. +
diff --git a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1.md b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1.md index 90a826d70b54c..23b4f3214edb9 100644 --- a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1.md +++ b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1.md @@ -18,6 +18,7 @@ weight: 4 PersistentVolumeClaim is a user's request for and claim to a persistent volume +
- **apiVersion**: v1 @@ -45,6 +46,7 @@ PersistentVolumeClaim is a user's request for and claim to a persistent volume PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes +
- **accessModes** ([]string) @@ -96,6 +98,7 @@ PersistentVolumeClaimSpec describes the common attributes of storage devices and PersistentVolumeClaimStatus is the current status of a persistent volume claim. +
- **accessModes** ([]string) @@ -154,6 +157,7 @@ PersistentVolumeClaimStatus is the current status of a persistent volume claim. PersistentVolumeClaimList is a list of PersistentVolumeClaim items. +
- **apiVersion**: v1 @@ -177,6 +181,7 @@ PersistentVolumeClaimList is a list of PersistentVolumeClaim items. +
diff --git a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-v1.md b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-v1.md index 683e9128f2dae..cbc4a613d5325 100644 --- a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-v1.md +++ b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-v1.md @@ -18,6 +18,7 @@ weight: 5 PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes +
- **apiVersion**: v1 @@ -45,6 +46,7 @@ PersistentVolume (PV) is a storage resource provisioned by an administrator. It PersistentVolumeSpec is the specification of a persistent volume. +
- **accessModes** ([]string) @@ -824,6 +826,7 @@ PersistentVolumeSpec is the specification of a persistent volume. PersistentVolumeStatus is the current status of a persistent volume. +
- **message** (string) @@ -845,6 +848,7 @@ PersistentVolumeStatus is the current status of a persistent volume. PersistentVolumeList is a list of PersistentVolume items. +
- **apiVersion**: v1 @@ -868,6 +872,7 @@ PersistentVolumeList is a list of PersistentVolume items. +
diff --git a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/secret-v1.md b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/secret-v1.md index fecb87314ce91..84d9a08c0f0c9 100644 --- a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/secret-v1.md +++ b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/secret-v1.md @@ -18,6 +18,7 @@ weight: 2 Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes. +
- **apiVersion**: v1 @@ -53,6 +54,7 @@ Secret holds secret data of a certain type. The total bytes of the values in the SecretList is a list of Secret. +
- **apiVersion**: v1 @@ -76,6 +78,7 @@ SecretList is a list of Secret. +
diff --git a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/storage-class-v1.md b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/storage-class-v1.md index 38329ee3f044f..752735f6f6771 100644 --- a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/storage-class-v1.md +++ b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/storage-class-v1.md @@ -20,6 +20,7 @@ StorageClass describes the parameters for a class of storage for which Persisten StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name. +
- **apiVersion**: storage.k8s.io/v1 @@ -85,6 +86,7 @@ StorageClasses are non-namespaced; the name of the storage class according to et StorageClassList is a collection of storage classes. +
- **apiVersion**: storage.k8s.io/v1 @@ -108,6 +110,7 @@ StorageClassList is a collection of storage classes. +
diff --git a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/volume-attachment-v1.md b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/volume-attachment-v1.md index d4951081808eb..95102c3988a1e 100644 --- a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/volume-attachment-v1.md +++ b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/volume-attachment-v1.md @@ -20,6 +20,7 @@ VolumeAttachment captures the intent to attach or detach the specified volume to VolumeAttachment objects are non-namespaced. +
- **apiVersion**: storage.k8s.io/v1 @@ -47,6 +48,7 @@ VolumeAttachment objects are non-namespaced. VolumeAttachmentSpec is the specification of a VolumeAttachment request. +
- **attacher** (string), required @@ -79,6 +81,7 @@ VolumeAttachmentSpec is the specification of a VolumeAttachment request. VolumeAttachmentStatus is the status of a VolumeAttachment request. +
- **attached** (boolean), required @@ -132,6 +135,7 @@ VolumeAttachmentStatus is the status of a VolumeAttachment request. VolumeAttachmentList is a collection of VolumeAttachment objects. +
- **apiVersion**: storage.k8s.io/v1 @@ -155,6 +159,7 @@ VolumeAttachmentList is a collection of VolumeAttachment objects. +
diff --git a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/volume.md b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/volume.md index ad1ee29ae2713..bacc2b08adb33 100644 --- a/content/en/docs/reference/kubernetes-api/config-and-storage-resources/volume.md +++ b/content/en/docs/reference/kubernetes-api/config-and-storage-resources/volume.md @@ -16,6 +16,7 @@ weight: 3 Volume represents a named volume in a pod that may be accessed by any container in the pod. +
- **name** (string), required diff --git a/content/en/docs/reference/kubernetes-api/extend-resources/custom-resource-definition-v1.md b/content/en/docs/reference/kubernetes-api/extend-resources/custom-resource-definition-v1.md index a50beb0b5f81f..3fa3bc9a740f9 100644 --- a/content/en/docs/reference/kubernetes-api/extend-resources/custom-resource-definition-v1.md +++ b/content/en/docs/reference/kubernetes-api/extend-resources/custom-resource-definition-v1.md @@ -18,6 +18,7 @@ weight: 1 CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format \<.spec.name>.\<.spec.group>. +
- **apiVersion**: apiextensions.k8s.io/v1 @@ -44,6 +45,7 @@ CustomResourceDefinition represents a resource that should be exposed on the API CustomResourceDefinitionSpec describes how a user wants their resource to appear +
- **group** (string), required @@ -271,6 +273,7 @@ CustomResourceDefinitionSpec describes how a user wants their resource to appear CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition +
- **acceptedNames** (CustomResourceDefinitionNames) @@ -345,6 +348,7 @@ CustomResourceDefinitionStatus indicates the state of the CustomResourceDefiniti CustomResourceDefinitionList is a list of CustomResourceDefinition objects. +
- **apiVersion**: apiextensions.k8s.io/v1 @@ -367,6 +371,7 @@ CustomResourceDefinitionList is a list of CustomResourceDefinition objects. +
diff --git a/content/en/docs/reference/kubernetes-api/extend-resources/mutating-webhook-configuration-v1.md b/content/en/docs/reference/kubernetes-api/extend-resources/mutating-webhook-configuration-v1.md index ae166576e783f..ac32c9aaaad84 100644 --- a/content/en/docs/reference/kubernetes-api/extend-resources/mutating-webhook-configuration-v1.md +++ b/content/en/docs/reference/kubernetes-api/extend-resources/mutating-webhook-configuration-v1.md @@ -18,6 +18,7 @@ weight: 2 MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. +
- **apiVersion**: admissionregistration.k8s.io/v1 @@ -207,6 +208,7 @@ MutatingWebhookConfiguration describes the configuration of and admission webhoo MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. +
- **apiVersion**: admissionregistration.k8s.io/v1 @@ -230,6 +232,7 @@ MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. +
diff --git a/content/en/docs/reference/kubernetes-api/extend-resources/validating-webhook-configuration-v1.md b/content/en/docs/reference/kubernetes-api/extend-resources/validating-webhook-configuration-v1.md index 80a62f4c969f6..a680b1f7aadb2 100644 --- a/content/en/docs/reference/kubernetes-api/extend-resources/validating-webhook-configuration-v1.md +++ b/content/en/docs/reference/kubernetes-api/extend-resources/validating-webhook-configuration-v1.md @@ -18,6 +18,7 @@ weight: 3 ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. +
- **apiVersion**: admissionregistration.k8s.io/v1 @@ -197,6 +198,7 @@ ValidatingWebhookConfiguration describes the configuration of and admission webh ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. +
- **apiVersion**: admissionregistration.k8s.io/v1 @@ -220,6 +222,7 @@ ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. +
diff --git a/content/en/docs/reference/kubernetes-api/policies-resources/limit-range-v1.md b/content/en/docs/reference/kubernetes-api/policies-resources/limit-range-v1.md index 3f56aaec90ade..d73c4d3630f10 100644 --- a/content/en/docs/reference/kubernetes-api/policies-resources/limit-range-v1.md +++ b/content/en/docs/reference/kubernetes-api/policies-resources/limit-range-v1.md @@ -18,6 +18,7 @@ weight: 1 LimitRange sets resource usage limits for each kind of resource in a Namespace. +
- **apiVersion**: v1 @@ -41,6 +42,7 @@ LimitRange sets resource usage limits for each kind of resource in a Namespace. LimitRangeSpec defines a min/max usage limit for resources that match on kind. +
- **limits** ([]LimitRangeItem), required @@ -81,6 +83,7 @@ LimitRangeSpec defines a min/max usage limit for resources that match on kind. LimitRangeList is a list of LimitRange items. +
- **apiVersion**: v1 @@ -104,6 +107,7 @@ LimitRangeList is a list of LimitRange items. +
diff --git a/content/en/docs/reference/kubernetes-api/policies-resources/network-policy-v1.md b/content/en/docs/reference/kubernetes-api/policies-resources/network-policy-v1.md index 9caa612c8ad0e..798a3dc8911b0 100644 --- a/content/en/docs/reference/kubernetes-api/policies-resources/network-policy-v1.md +++ b/content/en/docs/reference/kubernetes-api/policies-resources/network-policy-v1.md @@ -18,6 +18,7 @@ weight: 3 NetworkPolicy describes what network traffic is allowed for a set of Pods +
- **apiVersion**: networking.k8s.io/v1 @@ -41,6 +42,7 @@ NetworkPolicy describes what network traffic is allowed for a set of Pods NetworkPolicySpec provides the specification of a NetworkPolicy +
- **podSelector** (}}">LabelSelector), required @@ -176,6 +178,7 @@ NetworkPolicySpec provides the specification of a NetworkPolicy NetworkPolicyList is a list of NetworkPolicy objects. +
- **apiVersion**: networking.k8s.io/v1 @@ -199,6 +202,7 @@ NetworkPolicyList is a list of NetworkPolicy objects. +
diff --git a/content/en/docs/reference/kubernetes-api/policies-resources/pod-disruption-budget-v1beta1.md b/content/en/docs/reference/kubernetes-api/policies-resources/pod-disruption-budget-v1beta1.md index af5cc576ff7a6..47b9d83a7e092 100644 --- a/content/en/docs/reference/kubernetes-api/policies-resources/pod-disruption-budget-v1beta1.md +++ b/content/en/docs/reference/kubernetes-api/policies-resources/pod-disruption-budget-v1beta1.md @@ -18,6 +18,7 @@ weight: 4 PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods +
- **apiVersion**: policy/v1beta1 @@ -44,6 +45,7 @@ PodDisruptionBudget is an object to define the max disruption that can be caused PodDisruptionBudgetSpec is a description of a PodDisruptionBudget. +
- **maxUnavailable** (IntOrString) @@ -71,6 +73,7 @@ PodDisruptionBudgetSpec is a description of a PodDisruptionBudget. PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget. Status may trail the actual state of a system. +
- **currentHealthy** (int32), required @@ -107,6 +110,7 @@ PodDisruptionBudgetStatus represents information about the status of a PodDisrup PodDisruptionBudgetList is a collection of PodDisruptionBudgets. +
- **apiVersion**: policy/v1beta1 @@ -128,6 +132,7 @@ PodDisruptionBudgetList is a collection of PodDisruptionBudgets. +
diff --git a/content/en/docs/reference/kubernetes-api/policies-resources/pod-security-policy-v1beta1.md b/content/en/docs/reference/kubernetes-api/policies-resources/pod-security-policy-v1beta1.md index b9d5aa359eb27..1d2eac8837808 100644 --- a/content/en/docs/reference/kubernetes-api/policies-resources/pod-security-policy-v1beta1.md +++ b/content/en/docs/reference/kubernetes-api/policies-resources/pod-security-policy-v1beta1.md @@ -18,6 +18,7 @@ weight: 5 PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container. +
- **apiVersion**: policy/v1beta1 @@ -41,6 +42,7 @@ PodSecurityPolicy governs the ability to make requests that affect the Security PodSecurityPolicySpec defines the policy enforced. +
- **runAsUser** (RunAsUserStrategyOptions), required @@ -317,6 +319,7 @@ PodSecurityPolicySpec defines the policy enforced. PodSecurityPolicyList is a list of PodSecurityPolicy objects. +
- **apiVersion**: policy/v1beta1 @@ -340,6 +343,7 @@ PodSecurityPolicyList is a list of PodSecurityPolicy objects. +
diff --git a/content/en/docs/reference/kubernetes-api/policies-resources/resource-quota-v1.md b/content/en/docs/reference/kubernetes-api/policies-resources/resource-quota-v1.md index 1bf6e4258d475..66b0451d2d8cc 100644 --- a/content/en/docs/reference/kubernetes-api/policies-resources/resource-quota-v1.md +++ b/content/en/docs/reference/kubernetes-api/policies-resources/resource-quota-v1.md @@ -18,6 +18,7 @@ weight: 2 ResourceQuota sets aggregate quota restrictions enforced per namespace +
- **apiVersion**: v1 @@ -45,6 +46,7 @@ ResourceQuota sets aggregate quota restrictions enforced per namespace ResourceQuotaSpec defines the desired hard limits to enforce for Quota. +
- **hard** (map[string]}}">Quantity) @@ -88,6 +90,7 @@ ResourceQuotaSpec defines the desired hard limits to enforce for Quota. ResourceQuotaStatus defines the enforced hard limits and observed use. +
- **hard** (map[string]}}">Quantity) @@ -105,6 +108,7 @@ ResourceQuotaStatus defines the enforced hard limits and observed use. ResourceQuotaList is a list of ResourceQuota items. +
- **apiVersion**: v1 @@ -128,6 +132,7 @@ ResourceQuotaList is a list of ResourceQuota items. +
diff --git a/content/en/docs/reference/kubernetes-api/services-resources/endpoint-slice-v1beta1.md b/content/en/docs/reference/kubernetes-api/services-resources/endpoint-slice-v1beta1.md index ada29fb290e12..bb8c7213bb53f 100644 --- a/content/en/docs/reference/kubernetes-api/services-resources/endpoint-slice-v1beta1.md +++ b/content/en/docs/reference/kubernetes-api/services-resources/endpoint-slice-v1beta1.md @@ -18,6 +18,7 @@ weight: 3 EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints. +
- **apiVersion**: discovery.k8s.io/v1beta1 @@ -123,6 +124,7 @@ EndpointSlice represents a subset of the endpoints that implement a service. For EndpointSliceList represents a list of endpoint slices +
- **apiVersion**: discovery.k8s.io/v1beta1 @@ -146,6 +148,7 @@ EndpointSliceList represents a list of endpoint slices +
diff --git a/content/en/docs/reference/kubernetes-api/services-resources/endpoints-v1.md b/content/en/docs/reference/kubernetes-api/services-resources/endpoints-v1.md index 0c41fd98d19f2..b0c73533f8e20 100644 --- a/content/en/docs/reference/kubernetes-api/services-resources/endpoints-v1.md +++ b/content/en/docs/reference/kubernetes-api/services-resources/endpoints-v1.md @@ -29,6 +29,7 @@ Endpoints is a collection of endpoints that implement the actual service. Exampl }, ] +
- **apiVersion**: v1 @@ -131,6 +132,7 @@ Endpoints is a collection of endpoints that implement the actual service. Exampl EndpointsList is a list of endpoints. +
- **apiVersion**: v1 @@ -154,6 +156,7 @@ EndpointsList is a list of endpoints. +
diff --git a/content/en/docs/reference/kubernetes-api/services-resources/ingress-class-v1.md b/content/en/docs/reference/kubernetes-api/services-resources/ingress-class-v1.md index b593e7940827b..121c9551ebbd1 100644 --- a/content/en/docs/reference/kubernetes-api/services-resources/ingress-class-v1.md +++ b/content/en/docs/reference/kubernetes-api/services-resources/ingress-class-v1.md @@ -18,6 +18,7 @@ weight: 5 IngressClass represents the class of the Ingress, referenced by the Ingress Spec. The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class. +
- **apiVersion**: networking.k8s.io/v1 @@ -41,6 +42,7 @@ IngressClass represents the class of the Ingress, referenced by the Ingress Spec IngressClassSpec provides information about the class of an Ingress. +
- **controller** (string) @@ -58,6 +60,7 @@ IngressClassSpec provides information about the class of an Ingress. IngressClassList is a collection of IngressClasses. +
- **apiVersion**: networking.k8s.io/v1 @@ -81,6 +84,7 @@ IngressClassList is a collection of IngressClasses. +
diff --git a/content/en/docs/reference/kubernetes-api/services-resources/ingress-v1.md b/content/en/docs/reference/kubernetes-api/services-resources/ingress-v1.md index e2ac01d17ab23..003ad959ea8f4 100644 --- a/content/en/docs/reference/kubernetes-api/services-resources/ingress-v1.md +++ b/content/en/docs/reference/kubernetes-api/services-resources/ingress-v1.md @@ -18,6 +18,7 @@ weight: 4 Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc. +
- **apiVersion**: networking.k8s.io/v1 @@ -45,6 +46,7 @@ Ingress is a collection of rules that allow inbound connections to reach the end IngressSpec describes the Ingress the user wishes to exist. +
- **defaultBackend** (IngressBackend) @@ -204,6 +206,7 @@ IngressSpec describes the Ingress the user wishes to exist. IngressStatus describe the current state of the Ingress. +
- **loadBalancer** (LoadBalancerStatus) @@ -259,6 +262,7 @@ IngressStatus describe the current state of the Ingress. IngressList is a collection of Ingress. +
- **apiVersion**: networking.k8s.io/v1 @@ -282,6 +286,7 @@ IngressList is a collection of Ingress. +
diff --git a/content/en/docs/reference/kubernetes-api/services-resources/service-v1.md b/content/en/docs/reference/kubernetes-api/services-resources/service-v1.md index 35288d707bc0d..bfb2c819bd64b 100644 --- a/content/en/docs/reference/kubernetes-api/services-resources/service-v1.md +++ b/content/en/docs/reference/kubernetes-api/services-resources/service-v1.md @@ -18,6 +18,7 @@ weight: 1 Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy. +
- **apiVersion**: v1 @@ -45,6 +46,7 @@ Service is a named abstraction of software service (for example, mysql) consisti ServiceSpec describes the attributes that a user creates on a service. +
- **selector** (map[string]string) @@ -182,6 +184,7 @@ ServiceSpec describes the attributes that a user creates on a service. ServiceStatus represents the current status of a service. +
- **conditions** ([]Condition) @@ -275,6 +278,7 @@ ServiceStatus represents the current status of a service. ServiceList holds a list of services. +
- **apiVersion**: v1 @@ -298,6 +302,7 @@ ServiceList holds a list of services. +
diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/container.md b/content/en/docs/reference/kubernetes-api/workloads-resources/container.md index 9a6ceb47c3f37..d87cd422c84d2 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/container.md +++ b/content/en/docs/reference/kubernetes-api/workloads-resources/container.md @@ -18,6 +18,7 @@ weight: 2 A single application container that you want to run within a pod. +
- **name** (string), required @@ -583,6 +584,7 @@ A single application container that you want to run within a pod. ContainerStatus contains details for the current status of this container. +
- **name** (string), required diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/controller-revision-v1.md b/content/en/docs/reference/kubernetes-api/workloads-resources/controller-revision-v1.md index e2aea279cc686..950e9d729c332 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/controller-revision-v1.md +++ b/content/en/docs/reference/kubernetes-api/workloads-resources/controller-revision-v1.md @@ -18,6 +18,7 @@ weight: 9 ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers. +
- **apiVersion**: apps/v1 @@ -75,6 +76,7 @@ ControllerRevision implements an immutable snapshot of state data. Clients are r ControllerRevisionList is a resource containing a list of ControllerRevision objects. +
- **apiVersion**: apps/v1 @@ -98,6 +100,7 @@ ControllerRevisionList is a resource containing a list of ControllerRevision obj +
diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/cron-job-v1beta1.md b/content/en/docs/reference/kubernetes-api/workloads-resources/cron-job-v1beta1.md index d29efa2068161..22a0135bf851c 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/cron-job-v1beta1.md +++ b/content/en/docs/reference/kubernetes-api/workloads-resources/cron-job-v1beta1.md @@ -18,6 +18,7 @@ weight: 12 CronJob represents the configuration of a single cron job. +
- **apiVersion**: batch/v1beta1 @@ -45,6 +46,7 @@ CronJob represents the configuration of a single cron job. CronJobSpec describes how the job execution will look like and when it will actually run. +
- **jobTemplate** (JobTemplateSpec), required @@ -93,6 +95,7 @@ CronJobSpec describes how the job execution will look like and when it will actu CronJobStatus represents the current state of a cron job. +
- **active** ([]}}">ObjectReference) @@ -113,6 +116,7 @@ CronJobStatus represents the current state of a cron job. CronJobList is a collection of cron jobs. +
- **apiVersion**: batch/v1beta1 @@ -136,6 +140,7 @@ CronJobList is a collection of cron jobs. +
diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/cron-job-v2alpha1.md b/content/en/docs/reference/kubernetes-api/workloads-resources/cron-job-v2alpha1.md index 882e5761f1bae..c7c2ba7a81441 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/cron-job-v2alpha1.md +++ b/content/en/docs/reference/kubernetes-api/workloads-resources/cron-job-v2alpha1.md @@ -18,6 +18,7 @@ weight: 13 CronJob represents the configuration of a single cron job. +
- **apiVersion**: batch/v2alpha1 @@ -45,6 +46,7 @@ CronJob represents the configuration of a single cron job. CronJobSpec describes how the job execution will look like and when it will actually run. +
- **jobTemplate** (JobTemplateSpec), required @@ -93,6 +95,7 @@ CronJobSpec describes how the job execution will look like and when it will actu CronJobStatus represents the current state of a cron job. +
- **active** ([]}}">ObjectReference) @@ -113,6 +116,7 @@ CronJobStatus represents the current state of a cron job. CronJobList is a collection of cron jobs. +
- **apiVersion**: batch/v2alpha1 @@ -136,6 +140,7 @@ CronJobList is a collection of cron jobs. +
diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/daemon-set-v1.md b/content/en/docs/reference/kubernetes-api/workloads-resources/daemon-set-v1.md index e353993395b11..95ae869be1e5e 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/daemon-set-v1.md +++ b/content/en/docs/reference/kubernetes-api/workloads-resources/daemon-set-v1.md @@ -18,6 +18,7 @@ weight: 10 DaemonSet represents the configuration of a daemon set. +
- **apiVersion**: apps/v1 @@ -45,6 +46,7 @@ DaemonSet represents the configuration of a daemon set. DaemonSetSpec is the specification of a daemon set. +
- **selector** (}}">LabelSelector), required @@ -95,6 +97,7 @@ DaemonSetSpec is the specification of a daemon set. DaemonSetStatus represents the current status of a daemon set. +
- **numberReady** (int32), required @@ -172,6 +175,7 @@ DaemonSetStatus represents the current status of a daemon set. DaemonSetList is a collection of daemon sets. +
- **apiVersion**: apps/v1 @@ -195,6 +199,7 @@ DaemonSetList is a collection of daemon sets. +
diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/deployment-v1.md b/content/en/docs/reference/kubernetes-api/workloads-resources/deployment-v1.md index 7a7098fb6f90b..7e5b39c92922a 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/deployment-v1.md +++ b/content/en/docs/reference/kubernetes-api/workloads-resources/deployment-v1.md @@ -18,6 +18,7 @@ weight: 7 Deployment enables declarative updates for Pods and ReplicaSets. +
- **apiVersion**: apps/v1 @@ -45,6 +46,7 @@ Deployment enables declarative updates for Pods and ReplicaSets. DeploymentSpec is the specification of the desired behavior of the Deployment. +
- **selector** (}}">LabelSelector), required @@ -116,6 +118,7 @@ DeploymentSpec is the specification of the desired behavior of the Deployment. DeploymentStatus is the most recently observed status of the Deployment. +
- **replicas** (int32) @@ -192,6 +195,7 @@ DeploymentStatus is the most recently observed status of the Deployment. DeploymentList is a list of Deployments. +
- **apiVersion**: apps/v1 @@ -215,6 +219,7 @@ DeploymentList is a list of Deployments. +
diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/ephemeral-container.md b/content/en/docs/reference/kubernetes-api/workloads-resources/ephemeral-container.md index 6916a4358003b..3f7eba43a9819 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/ephemeral-container.md +++ b/content/en/docs/reference/kubernetes-api/workloads-resources/ephemeral-container.md @@ -16,6 +16,7 @@ weight: 3 An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag. +
- **name** (string), required diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/horizontal-pod-autoscaler-v1.md b/content/en/docs/reference/kubernetes-api/workloads-resources/horizontal-pod-autoscaler-v1.md index bfa4fe6eb8925..5bb2f6e1757be 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/horizontal-pod-autoscaler-v1.md +++ b/content/en/docs/reference/kubernetes-api/workloads-resources/horizontal-pod-autoscaler-v1.md @@ -18,6 +18,7 @@ weight: 14 configuration of a horizontal pod autoscaler. +
- **apiVersion**: autoscaling/v1 @@ -45,6 +46,7 @@ configuration of a horizontal pod autoscaler. specification of a horizontal pod autoscaler. +
- **maxReplicas** (int32), required @@ -85,6 +87,7 @@ specification of a horizontal pod autoscaler. current status of a horizontal pod autoscaler +
- **currentReplicas** (int32), required @@ -117,6 +120,7 @@ current status of a horizontal pod autoscaler list of horizontal pod autoscaler objects. +
- **apiVersion**: autoscaling/v1 @@ -140,6 +144,7 @@ list of horizontal pod autoscaler objects. +
diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/horizontal-pod-autoscaler-v2beta2.md b/content/en/docs/reference/kubernetes-api/workloads-resources/horizontal-pod-autoscaler-v2beta2.md index 7cbda5b7775e8..56fd55d24b209 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/horizontal-pod-autoscaler-v2beta2.md +++ b/content/en/docs/reference/kubernetes-api/workloads-resources/horizontal-pod-autoscaler-v2beta2.md @@ -18,6 +18,7 @@ weight: 15 HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified. +
- **apiVersion**: autoscaling/v2beta2 @@ -45,6 +46,7 @@ HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, wh HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler. +
- **maxReplicas** (int32), required @@ -395,6 +397,7 @@ HorizontalPodAutoscalerSpec describes the desired functionality of the Horizonta HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler. +
- **conditions** ([]HorizontalPodAutoscalerCondition), required @@ -669,6 +672,7 @@ HorizontalPodAutoscalerStatus describes the current status of a horizontal pod a HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects. +
- **apiVersion**: autoscaling/v2beta2 @@ -692,6 +696,7 @@ HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects. +
diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/job-v1.md b/content/en/docs/reference/kubernetes-api/workloads-resources/job-v1.md index b766b9e6c813d..3deab1c4be626 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/job-v1.md +++ b/content/en/docs/reference/kubernetes-api/workloads-resources/job-v1.md @@ -18,6 +18,7 @@ weight: 11 Job represents the configuration of a single job. +
- **apiVersion**: batch/v1 @@ -45,6 +46,7 @@ Job represents the configuration of a single job. JobSpec describes how the job execution will look like. +
@@ -95,6 +97,7 @@ JobSpec describes how the job execution will look like. JobStatus represents the current state of a Job. +
- **startTime** (Time) @@ -169,6 +172,7 @@ JobStatus represents the current state of a Job. JobList is a collection of jobs. +
- **apiVersion**: batch/v1 @@ -192,6 +196,7 @@ JobList is a collection of jobs. +
diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/pod-template-v1.md b/content/en/docs/reference/kubernetes-api/workloads-resources/pod-template-v1.md index aadfbf4a66793..fec34df19f5b8 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/pod-template-v1.md +++ b/content/en/docs/reference/kubernetes-api/workloads-resources/pod-template-v1.md @@ -18,6 +18,7 @@ weight: 4 PodTemplate describes a template for creating copies of a predefined pod. +
- **apiVersion**: v1 @@ -41,6 +42,7 @@ PodTemplate describes a template for creating copies of a predefined pod. PodTemplateSpec describes the data a pod should have when created from a template +
- **metadata** (}}">ObjectMeta) @@ -58,6 +60,7 @@ PodTemplateSpec describes the data a pod should have when created from a templat PodTemplateList is a list of PodTemplates. +
- **apiVersion**: v1 @@ -81,6 +84,7 @@ PodTemplateList is a list of PodTemplates. +
diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/pod-v1.md b/content/en/docs/reference/kubernetes-api/workloads-resources/pod-v1.md index 4df98d54fba40..584c3381725f8 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/pod-v1.md +++ b/content/en/docs/reference/kubernetes-api/workloads-resources/pod-v1.md @@ -18,6 +18,7 @@ weight: 1 Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts. +
- **apiVersion**: v1 @@ -45,6 +46,7 @@ Pod is a collection of containers that can run on a host. This resource is creat PodSpec is a description of a pod. +
@@ -451,6 +453,7 @@ PodSpec is a description of a pod. PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot contact the control plane. +
- **nominatedNodeName** (string) @@ -564,6 +567,7 @@ PodStatus represents information about the status of a pod. Status may trail the PodList is a list of Pods. +
- **apiVersion**: v1 @@ -587,6 +591,7 @@ PodList is a list of Pods. +
diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/priority-class-v1.md b/content/en/docs/reference/kubernetes-api/workloads-resources/priority-class-v1.md index 39fc70a376237..30b40e6840e67 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/priority-class-v1.md +++ b/content/en/docs/reference/kubernetes-api/workloads-resources/priority-class-v1.md @@ -18,6 +18,7 @@ weight: 16 PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. +
- **apiVersion**: scheduling.k8s.io/v1 @@ -53,6 +54,7 @@ PriorityClass defines mapping from a priority class name to the priority integer PriorityClassList is a collection of priority classes. +
- **apiVersion**: scheduling.k8s.io/v1 @@ -76,6 +78,7 @@ PriorityClassList is a collection of priority classes. +
diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/replica-set-v1.md b/content/en/docs/reference/kubernetes-api/workloads-resources/replica-set-v1.md index ac9f9a475b06d..429a1bd5a2af2 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/replica-set-v1.md +++ b/content/en/docs/reference/kubernetes-api/workloads-resources/replica-set-v1.md @@ -18,6 +18,7 @@ weight: 6 ReplicaSet ensures that a specified number of pod replicas are running at any given time. +
- **apiVersion**: apps/v1 @@ -45,6 +46,7 @@ ReplicaSet ensures that a specified number of pod replicas are running at any gi ReplicaSetSpec is the specification of a ReplicaSet. +
- **selector** (}}">LabelSelector), required @@ -70,6 +72,7 @@ ReplicaSetSpec is the specification of a ReplicaSet. ReplicaSetStatus represents the current status of a ReplicaSet. +
- **replicas** (int32), required @@ -131,6 +134,7 @@ ReplicaSetStatus represents the current status of a ReplicaSet. ReplicaSetList is a collection of ReplicaSets. +
- **apiVersion**: apps/v1 @@ -154,6 +158,7 @@ ReplicaSetList is a collection of ReplicaSets. +
diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/replication-controller-v1.md b/content/en/docs/reference/kubernetes-api/workloads-resources/replication-controller-v1.md index e9d4268a3ebdf..2970b6670c45e 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/replication-controller-v1.md +++ b/content/en/docs/reference/kubernetes-api/workloads-resources/replication-controller-v1.md @@ -18,6 +18,7 @@ weight: 5 ReplicationController represents the configuration of a replication controller. +
- **apiVersion**: v1 @@ -45,6 +46,7 @@ ReplicationController represents the configuration of a replication controller. ReplicationControllerSpec is the specification of a replication controller. +
- **selector** (map[string]string) @@ -70,6 +72,7 @@ ReplicationControllerSpec is the specification of a replication controller. ReplicationControllerStatus represents the current status of a replication controller. +
- **replicas** (int32), required @@ -131,6 +134,7 @@ ReplicationControllerStatus represents the current status of a replication contr ReplicationControllerList is a collection of replication controllers. +
- **apiVersion**: v1 @@ -154,6 +158,7 @@ ReplicationControllerList is a collection of replication controllers. +
diff --git a/content/en/docs/reference/kubernetes-api/workloads-resources/stateful-set-v1.md b/content/en/docs/reference/kubernetes-api/workloads-resources/stateful-set-v1.md index 0e6d9421cb4d5..1a55fa4c1db47 100644 --- a/content/en/docs/reference/kubernetes-api/workloads-resources/stateful-set-v1.md +++ b/content/en/docs/reference/kubernetes-api/workloads-resources/stateful-set-v1.md @@ -21,6 +21,7 @@ StatefulSet represents a set of pods with consistent identities. Identities are - Storage: As many VolumeClaims as requested. The StatefulSet guarantees that a given network identity will always map to the same storage identity. +
- **apiVersion**: apps/v1 @@ -47,6 +48,7 @@ The StatefulSet guarantees that a given network identity will always map to the A StatefulSetSpec is the specification of a StatefulSet. +
- **serviceName** (string), required @@ -106,6 +108,7 @@ A StatefulSetSpec is the specification of a StatefulSet. StatefulSetStatus represents the current state of a StatefulSet. +
- **replicas** (int32), required @@ -179,6 +182,7 @@ StatefulSetStatus represents the current state of a StatefulSet. StatefulSetList is a collection of StatefulSets. +
- **apiVersion**: apps/v1 @@ -200,6 +204,7 @@ StatefulSetList is a collection of StatefulSets. +